README.md
1Doxygen
2=======
3
4To generate all the documentation run the following
5from this directory:
6
7 doxygen Doxyfile
8
9The resulting output goes to
10
11 /tmp/doxygen
12
13To view those file locally in your browser run:
14
15 cd /tmp/doxygen/html; python -m SimpleHTTPServer 8000
16
17and visit
18
19 http://localhost:8000
20
21If you want to have the documentation regenerated on every save then
22you can install `entr` and run the following from this directory:
23
24 find ../../include/ ../../src/ . | entr doxygen ./Doxyfile
25
26Install
27-------
28
29For a linux desktop you can install the doxygen tool via:
30
31 sudo apt install doxygen
32
