aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorUwe Hermann2011-11-11 21:37:41 +0100
committerUwe Hermann2011-11-11 21:37:41 +0100
commit47a116ef4ff653a635b3b0fc7c5eebe5ea464070 (patch)
tree2c7f24c26aa1deda5cd85bdcba2cc1539c7892c5 /HACKING
parent6c278b19b4bd7ab169e03f183d98232ba4ae3341 (diff)
HACKING: Document the examples/ directory layout.
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING11
1 files changed, 11 insertions, 0 deletions
diff --git a/HACKING b/HACKING
index daffdb2..b03d705 100644
--- a/HACKING
+++ b/HACKING
@@ -40,3 +40,14 @@ Development guidelines
- Variables that are used to store register values read from registers or
to be stored in a register should be named reg8, reg16, reg32 etc.
+ - In the examples directory, the following structure should be used:
+
+ - One (or more) subdirectories for the type of microcontroller, e.g.
+ lm3s, lpc13xx, stm32/f1, stm32/f2, stm32/f4.
+
+ - One subdirectory in there for each eval board or piece of hardware, e.g.
+ stm32-h103, lisa-m, stm32vl-discovery, stm32f4-discovery, etc.
+
+ - One subdirectory in there for each example, e.g.
+ miniblink, button, usart, usb_dfu, etc.
+