Skip to content

Commit 7722740

Browse files
committed
Add some hints to the documentation.
1 parent 708361c commit 7722740

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

+39
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,42 @@ In particular the objectives of the device are:
1616
- quick interaction with an easy human-machine interface
1717
- permanent feedback on which task is active at the moment
1818
- provide digital interface to recorded times (TBD: through WiFi, Bluetooth, wired serial interface, ...)
19+
20+
## Generate the documentation
21+
22+
Documentation may be generated with Doxygen. Simply call in the root directory of this repository:
23+
24+
doxygen
25+
26+
The HTML documentation will be written to [here](doc/html/index.xhtml).
27+
28+
## Build
29+
30+
The build configuration for the device's software is generated with PlatformIO. Please refer to the [documentation](https://docs.platformio.org/) for build instructions.
31+
32+
## Simulate
33+
34+
[`wokwi.toml`](wokwi_files/wokwi.toml) is a project configuration for the Visual Studio Code extension [Wokwi Simulator](https://marketplace.visualstudio.com/items?itemName=wokwi.wokwi-vscode).
35+
36+
## Contribute
37+
38+
### Document you code
39+
40+
Please document your code in Doxygen compatible syntax.
41+
42+
### C/C++ source code
43+
44+
Please format your changes using ClangFormat.
45+
A style configuration file is given: [`.clang-format`](.clang-format)
46+
47+
### Doxygen configuration
48+
49+
If you change [`Doxyfile`](Doxyfile), please do a ['cleanup'](https://stackoverflow.com/questions/71157463/what-part-of-the-doxygen-configuration-doxyfile-is-recommended-for-version-con#comment125783393_71157463) by using the output of `doxygen -x`.
50+
For example
51+
52+
doxygen -x > Doxyfile.tmp && mv Doxyfile.tmp Doxyfile
53+
54+
### PlatformIO configuration
55+
56+
If you change [`platformio.ini`](platformio.ini), preferably use [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html#platformio-home).
57+
This helps to keep a common style in that file.

0 commit comments

Comments
 (0)