Add architecture diagram to README

0xrotense · Dec 12, 2021 · 33c8694 · 33c8694
1 parent 4e04f4b
commit 33c8694
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -139,7 +139,15 @@ $ dune runtest test/unit_tests/
 $ dune runtest test/rom_tests/
 ```
 
-## Project Structure
+## Architecture diagram
+
+Here is a rough sketch of the various modules and their relation between them.
+
+<div align="center">
+  <img src="/resource/screenshot/diagram/camlboy_architecture.png" height="500"/>
+</div>
+
+## Directory Structure
 
 - `lib` - Main emulator code
 - `bin` - UI code

diff --git a/resource/diagram/camlboy_architecture.png b/resource/diagram/camlboy_architecture.png