aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorAlex Bennée <alex.bennee@linaro.org>2017-06-21 16:42:35 +0100
committerPeter Maydell <peter.maydell@linaro.org>2017-06-29 11:48:51 +0100
commitbbd5014ac083a60196b9ad906ca2d7d989711e0f (patch)
tree133d682259bcd851055947ec6e4bcd9e936d068e /README
parent690b4263f3ca6ca0b6e650758a5d83b504994404 (diff)
README: document the coding style used for risu
We also include the an Emacs .dir-locals (as per QEMU) that enforces this layout. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-id: 20170621154244.28309-2-alex.bennee@linaro.org Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Diffstat (limited to 'README')
-rw-r--r--README9
1 files changed, 9 insertions, 0 deletions
diff --git a/README b/README
index 4b37b4e..858a349 100644
--- a/README
+++ b/README
@@ -42,6 +42,15 @@ architecture that we support and that you have a cross compiler
installed for. This is useful for confirming that your changes
to risu haven't broken anything.
+Coding Style
+------------
+
+risu follows the same coding style as the QEMU project, namely 4
+spaces (no tabs) for indentation and the One True Brace Style variant
+of K&R. The source tree includes a .dir-locals.el for Emacs users that
+will set this automatically. Other editors are available.
+
+
Usage
-----