aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/boards/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/boards/readme.txt')
-rw-r--r--os/hal/boards/readme.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/os/hal/boards/readme.txt b/os/hal/boards/readme.txt
new file mode 100644
index 000000000..b08a21bfb
--- /dev/null
+++ b/os/hal/boards/readme.txt
@@ -0,0 +1,6 @@
+This directory contains the support files for various board models. If you
+want to support a new board:
+- Create a new directory under ./boards, give it the name of your board.
+- Copy inside the new directory the files from a similar board.
+- Customize board.c, board.h and board.mk in order to correctly initialize
+ your board.