Do a better job with crate doc

Author: rlivings39

Cargo.toml

@@ -1,8 +1,10 @@
 [package]
 name = "notcc"
 description = "A compiler for a subset of C written in Rust. Based on the book \"Writing a C Compiler\" by Nora Sandler."
+readme = "rust_src/README.md"
 version = "0.1.0"
 edition = "2024"
+repository = "https://github.com/rlivings39/learning-compilers"
 
 [dependencies]
 clap = { version = "4.5.44", features = ["derive"] }

rust_src/README.md

@@ -0,0 +1,17 @@
+# notcc - A compiler for a subset of C
+
+This Crate implements a compiler for a subset of C based on the book "Writing a C Compiler" by Nora Sandler.
+
+## Usage
+
+Build the crate and view the CLI help
+
+```bash
+cargo run --- -h
+```
+
+To use this crate as a library have a look at the function `driver_main` which invokes the entire compiler driver as library interface.
+
+## Full documentation
+
+The full status of the compiler is described in [https://github.com/rlivings39/learning-compilers](https://github.com/rlivings39/learning-compilers)

rust_src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("README.md")]
 mod driver;
 pub mod error;