Add make_doc to README

pull/51/head
Andre Richter 4 years ago
parent e591fff883
commit 6c8e5488eb
No known key found for this signature in database
GPG Key ID: 2116C1AB102F615E

@ -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 - 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 overview of the additions, and show the source code `diff` to the previous
tutorial, so that you can conveniently inspect the changes/additions. tutorial, so that you can conveniently inspect the changes/additions.
- Some tutorials have a full-fledged, detailed text in addition to the `tl;dr` - Some tutorials have a full-fledged, detailed text in addition to the `tl;dr` section. The
section. The long-term plan is that all tutorials get a full text, but for now long-term plan is that all tutorials get a full text, but for now this is exclusive to
this is exclusive to tutorials where I think that `tl;dr` and `diff` are not tutorials where I think that `tl;dr` and `diff` are not enough to get the idea.
enough to get the idea.
- The code written in these tutorials supports and runs on the **Raspberry Pi - The code written in these tutorials supports and runs on the **Raspberry Pi
3** and the **Raspberry Pi 4**. 3** and the **Raspberry Pi 4**.
- Tutorials 1 till 5 are groundwork code which only makes sense to run in - 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. architectures and/or boards.
- I would really love if someone takes a shot at a **RISC-V** implementation! - I would really love if someone takes a shot at a **RISC-V** implementation!
- For editing, I recommend [Visual Studio Code] with [Rust Analyzer]. - For editing, I recommend [Visual Studio Code] with [Rust Analyzer].
- In addition to the tutorial text, also check out the `make doc` command to - In addition to the tutorial text, also check out the `make doc` command in each tutorial to browse
browse the code with HTML goodness. the code, which is extensively documented, with HTML goodness.
### Output of `make doc`
<img src="doc/make_doc.png" widht="880">
[Visual Studio Code]: https://code.visualstudio.com [Visual Studio Code]: https://code.visualstudio.com
[Rust Analyzer]: https://rust-analyzer.github.io [Rust Analyzer]: https://rust-analyzer.github.io

Binary file not shown.

After

Width:  |  Height:  |  Size: 225 KiB

Loading…
Cancel
Save