Documentation

README.md

@@ -2,4 +2,19 @@
 
 The `master` branch should now contain a semi-stable version whereas
 the latest version can be found on `dev`. I also use `dev` to sync
-my work so expect constant breaking changes on that branch.
+my work so expect constant breaking changes on that branch.
+
+This is designed to work on Linux using `nasm` and `gcc` requiring a library
+with `free`, `malloc`, and `printf` to be present (should be by default, 
+all may not be required if not used in your code). This may work in WSL
+
+## Usage
+
+`cargo run` will compile and run `main.why`. By default this runs an example
+using the `LinkedList` defined in `std/linked_list.why`.
+
+Use `cargo run -- -i error.why` and `cargo run -- -i error2.why` to see
+two examples of the rich error reporting in Whython
+
+Use `cargo run -- [args]` to pass arguments to Whython
+Use `cargo run -- -h` to get help