Skip to content

Commit 469bb86

Browse files
committed
Move docs and modify README
Signed-off-by: Harry Chen <i@harrychen.xyz>
1 parent 1525656 commit 469bb86

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ There are some fancy commands. For example,
2828
2. There might be some timing issue with the VGA signal. You can adjust your monitor manually if it doesn't display image as expected.
2929
3. When `TERM=vt220`, there is no color support but everything will work well. When `TERM=xterm-256color`, there is color support, but there might be some strange behaviors for we have not implemented all instructions in that mode.
3030

31+
## Documentation
32+
33+
You can refer to `doc/report.pdf` for a detailed explanation, or `doc/presentation.pdf` for a quick view of this project.
34+
35+
The source code is __not__ well documented, we sincerely apologize for the consequential inconvenience.
36+
3137
## Licence
3238

3339
This project is released under GPLv3, see `LICENSE` for legal text.

doc/presentation.pdf

1.34 MB
Binary file not shown.
File renamed without changes.

0 commit comments

Comments
 (0)