madcow/drybox-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Consolidate unfinished tasks and update documentation

Browse Source
This commit is contained in:
Leon Krieg
2024-10-02 06:12:19 +02:00
parent 8d94bd87a2
commit 481bf3aa70
8 changed files with 58 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/README.md
View File

@@ -31,24 +31,24 @@ Makefile for all build settings and make sure they are
correct for your current environment.
To remove build-related auxiliary files you may use one
of these commands:
of these commands, with varying levels of cleanliness:
make clean
make distclean
Isolated unit tests allow you to verify all testable
components are behaving as expected. Please note that most
tests will be added later down the road, when the project
has reached a more mature state. There is also support for
testing on simulated hardware if you have
Isolated unit tests allow you to verify all source modules
are behaving as expected. Please note that most tests will
be added later down the road, when the project has reached
a more mature state. There is also support for running the
binaries on simulated hardware if you have
[simavr](https://github.com/buserror/simavr) installed.
make check
make simulate
You can listen on the serial debug interface by running
the command below. This will also initialize all optional
submodules on first invocation.
You can listen on the serial debug interface by executing
the command below. Optional submodules will be initialized
on first invocation since they contain the necessary tools.
make listen