update readme

4 years ago · 0eabf2d370
parent 111786bfec
commit 0eabf2d370
1 changed files with 6 additions and 2 deletions
--- a/README.org
+++ b/README.org
@ -118,3 +118,7 @@
     Keeping such a style is /usually/ preferred, anyhow.

     See [[./src/error.rs][error.rs]] for more details.
+
+** Documentation
+   Run ~cargo test; cargo doc~ and then navigate to the exported HTML in =./target/doc/ghost/index.html=.
+   If you're building on stable, the documentation code samples will fail to compile. This is fine, the documentation pages will still be built all the same.