chore: whole swoop of enhanced documentation

README.md

@@ -4,7 +4,7 @@ minix-8086-rs is a Rust-based toolchain for analyzing and interpreting 16-bit 80
 
 It includes:
 - 📦 a.out Parser: Parses legacy MINIX executables.
-- 🛠 8086 Disassembler: Parses 16-bit instructions into an IR and prints them in a `objdump(1)`-style fasion.
+- 🛠 8086 Disassembler: Parses 16-bit instructions into an IR and prints them in a `objdump(1)`-style fashion.
 - 💻 8086 Interpreter: Interprets the 8086 instructions, i.e., the MINIX binary.
 
 ## Usage
@@ -19,6 +19,11 @@ Or run it directly:
 cargo run -- --help
 ```
 
+Run with debug output:
+```
+RUST_LOG=debug cargo run -- interpret -p ./a.out
+```
+
 CLI Options:
 ```
 $ cargo run -- --help
@@ -37,32 +42,21 @@ Options:
   -V, --version      Print version                                                     
 ```
 
-## Examples
-
-Disassemble a binary:
-
-```
-cargo run -- disasm -p ./a.out
-```
-
-Interpret a binary:
-```
-cargo run -- interpret -p ./a.out
-```
-
-Run with debug output:
-```
-RUST_LOG=debug cargo run -- interpret -p ./a.out
-```
-
 ## Status
 
 This project is under active development and primarily used by me to explore some Intel disassembly and learn some more Rust.
 Expect bugs and some missing features.
+I mainly test with 'official' binaries from the MINIX source tree.
 
 
 ## Documentation
 
+The documentation of the project itself can be accessed by using `cargo doc`.
+```
+$ cargo doc
+$ firefox target/doc/minix_8086_rs/index.html 
+```
+
 For the implementation of all instructions I used the Intel "8086 16-BIT HMOS MICROPROCESSOR" Spec, as well as [this](http://www.mlsite.net/8086/8086_table.txt) overview of all Opcode variants used in conjunction with [this](http://www.mlsite.net/8086/) decoding matrix.