diff --git a/README.org b/README.org index 23e344f..70980dd 100644 --- a/README.org +++ b/README.org @@ -1,7 +1,7 @@ * GHOST Rust bindings and Rust APIs for GHOST. -** Layout +** Layout ABI-compatable types and functions are all prefixed with ~GHOST_~ and are exported in the ~c~ module. Rust-native API variants are made as well, which have non-prefixed names. @@ -74,7 +74,7 @@ - [ ] Events: ~event.rs~ ***** Aliases - - [X] /Handle types/ + - [X] /Handle types/ **** Handles Handles keep the C ABI, but are re-wrtten with traits to be more idiomatic. @@ -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.