From af4d3da7a8ade986bd4f89956984fe8cae1b67cd Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Thu, 11 Oct 2018 10:29:28 +0100 Subject: [PATCH] link to Here Be Dragons --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6e4248b0c1..72def22803 100644 --- a/README.md +++ b/README.md @@ -234,6 +234,10 @@ Before attempting to develop on Riot you **must** read the developer guide for `matrix-react-sdk` at https://github.com/matrix-org/matrix-react-sdk, which also defines the design, architecture and style for Riot too. +You should also familiarise yourself with the "Here be Dragons" guide to the +tame & not-so-tame dragons (gotchas) which exist in the codebase: +https://docs.google.com/document/d/12jYzvkidrp1h7liEuLIe6BMdU0NUjndUYI971O06ooM + The idea of Riot is to be a relatively lightweight "skin" of customisations on top of the underlying `matrix-react-sdk`. `matrix-react-sdk` provides both the higher and lower level React components useful for building Matrix communication