Skip to content

Commit 6c8e548

Browse files
committed
Add make_doc to README
1 parent e591fff commit 6c8e548

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,9 @@ P.S.: In the future, Chinese :cn: versions of the tutorials will be maintained a
3333
- Each tutorial `README` will have a short `tl;dr` section giving a brief
3434
overview of the additions, and show the source code `diff` to the previous
3535
tutorial, so that you can conveniently inspect the changes/additions.
36-
- Some tutorials have a full-fledged, detailed text in addition to the `tl;dr`
37-
section. The long-term plan is that all tutorials get a full text, but for now
38-
this is exclusive to tutorials where I think that `tl;dr` and `diff` are not
39-
enough to get the idea.
36+
- Some tutorials have a full-fledged, detailed text in addition to the `tl;dr` section. The
37+
long-term plan is that all tutorials get a full text, but for now this is exclusive to
38+
tutorials where I think that `tl;dr` and `diff` are not enough to get the idea.
4039
- The code written in these tutorials supports and runs on the **Raspberry Pi
4140
3** and the **Raspberry Pi 4**.
4241
- 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
4847
architectures and/or boards.
4948
- I would really love if someone takes a shot at a **RISC-V** implementation!
5049
- For editing, I recommend [Visual Studio Code] with [Rust Analyzer].
51-
- In addition to the tutorial text, also check out the `make doc` command to
52-
browse the code with HTML goodness.
50+
- In addition to the tutorial text, also check out the `make doc` command in each tutorial to browse
51+
the code, which is extensively documented, with HTML goodness.
52+
53+
### Output of `make doc`
54+
55+
<img src="doc/make_doc.png" widht="880">
5356

5457
[Visual Studio Code]: https://code.visualstudio.com
5558
[Rust Analyzer]: https://rust-analyzer.github.io

doc/make_doc.png

225 KB
Loading

0 commit comments

Comments
 (0)