diff --git a/README.md b/README.md index 2928fa39..c2542f9d 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,9 @@ P.S.: In the future, Chinese :cn: versions of the tutorials will be maintained a - Each tutorial `README` will have a short `tl;dr` section giving a brief overview of the additions, and show the source code `diff` to the previous tutorial, so that you can conveniently inspect the changes/additions. -- Some tutorials have a full-fledged, detailed text in addition to the `tl;dr` - section. The long-term plan is that all tutorials get a full text, but for now - this is exclusive to tutorials where I think that `tl;dr` and `diff` are not - enough to get the idea. + - Some tutorials have a full-fledged, detailed text in addition to the `tl;dr` section. The + long-term plan is that all tutorials get a full text, but for now this is exclusive to + tutorials where I think that `tl;dr` and `diff` are not enough to get the idea. - The code written in these tutorials supports and runs on the **Raspberry Pi 3** and the **Raspberry Pi 4**. - Tutorials 1 till 5 are groundwork code which only makes sense to run in @@ -48,8 +47,12 @@ P.S.: In the future, Chinese :cn: versions of the tutorials will be maintained a architectures and/or boards. - I would really love if someone takes a shot at a **RISC-V** implementation! - For editing, I recommend [Visual Studio Code] with [Rust Analyzer]. -- In addition to the tutorial text, also check out the `make doc` command to - browse the code with HTML goodness. +- In addition to the tutorial text, also check out the `make doc` command in each tutorial to browse + the code, which is extensively documented, with HTML goodness. + +### Output of `make doc` + + [Visual Studio Code]: https://code.visualstudio.com [Rust Analyzer]: https://rust-analyzer.github.io diff --git a/doc/make_doc.png b/doc/make_doc.png new file mode 100644 index 00000000..8c57c299 Binary files /dev/null and b/doc/make_doc.png differ