aboutsummaryrefslogtreecommitdiffstats
path: root/ChibiOS_20.3.2/os/hal/boards/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'ChibiOS_20.3.2/os/hal/boards/readme.txt')
-rw-r--r--ChibiOS_20.3.2/os/hal/boards/readme.txt17
1 files changed, 17 insertions, 0 deletions
diff --git a/ChibiOS_20.3.2/os/hal/boards/readme.txt b/ChibiOS_20.3.2/os/hal/boards/readme.txt
new file mode 100644
index 0000000..c033834
--- /dev/null
+++ b/ChibiOS_20.3.2/os/hal/boards/readme.txt
@@ -0,0 +1,17 @@
+This directory contains the support files for various board models. If you
+want to support a new board:
+- Create a new directory under ./os/hal/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.
+
+The files in those board directories containing:
+- <board>/cfg/board.chcfg
+- <board>/cfg/board.fmpp
+are generated automatically, just run the "fmpp" tool from within <board>/cfg,
+the download is available here: http://fmpp.sourceforge.net, note, it
+requires Java.
+
+All board files can be batch-regenerated automatically by running the
+genboards.sh script in this same directory.
+