diff options
author | Giovanni Di Sirio <gdisirio@gmail.com> | 2017-02-07 09:23:26 +0000 |
---|---|---|
committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2017-02-07 09:23:26 +0000 |
commit | 6e5e2aa9acbbf646746913a940faf8c6beb5d0e8 (patch) | |
tree | 5e08ae0ab9d22fa660a9b286a7a3a7fb19703cb7 /doc/readme.txt | |
parent | 3b2070d6e7df5bafd95e24c5b4c5435e8aefcaf4 (diff) | |
download | ChibiOS-6e5e2aa9acbbf646746913a940faf8c6beb5d0e8.tar.gz ChibiOS-6e5e2aa9acbbf646746913a940faf8c6beb5d0e8.tar.bz2 ChibiOS-6e5e2aa9acbbf646746913a940faf8c6beb5d0e8.zip |
Documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10094 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'doc/readme.txt')
-rwxr-xr-x | doc/readme.txt | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/readme.txt b/doc/readme.txt new file mode 100755 index 000000000..71ed457f3 --- /dev/null +++ b/doc/readme.txt @@ -0,0 +1,10 @@ +*** Documentation build procedure ***
+
+The following software must be installed:
+- Doxygen 1.8.8 or later.
+- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
+ in order to make Graphviz accessible by Doxygen.
+
+Build procedure:
+- Run: doxygen Doxyfile_html or Doxyfile_chm
+
|