aboutsummaryrefslogtreecommitdiffstats
path: root/doc/readme.txt
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-11-23 17:14:56 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2014-11-23 17:14:56 +0000
commit76b6b659291973e23b6ecbe8459baeac0577f1d8 (patch)
tree4ecc4c8fb18239f1b637db0e574de97708377bd1 /doc/readme.txt
parent6d52bb255ead3e6ad8f76dce46f96d43e2944ea7 (diff)
downloadChibiOS-76b6b659291973e23b6ecbe8459baeac0577f1d8.tar.gz
ChibiOS-76b6b659291973e23b6ecbe8459baeac0577f1d8.tar.bz2
ChibiOS-76b6b659291973e23b6ecbe8459baeac0577f1d8.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7527 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'doc/readme.txt')
-rw-r--r--doc/readme.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/readme.txt b/doc/readme.txt
new file mode 100644
index 000000000..9924d779f
--- /dev/null
+++ b/doc/readme.txt
@@ -0,0 +1,11 @@
+*** Documentation build procedure ***
+
+The following software must be installed:
+- Doxygen 1.7.4 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 Doxywizard.
+- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
+- Start.