You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39
Original file line number
Diff line number
Diff line change
@@ -16,3 +16,42 @@ In particular the objectives of the device are:
16
16
- quick interaction with an easy human-machine interface
17
17
- permanent feedback on which task is active at the moment
18
18
- 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`.
If you change [`platformio.ini`](platformio.ini), preferably use [PlatformIO Home](https://docs.platformio.org/en/latest/home/index.html#platformio-home).
0 commit comments