update readme

master
Avril 4 years ago
parent 111786bfec
commit 0eabf2d370
Signed by: flanchan
GPG Key ID: 284488987C31F630

@ -1,7 +1,7 @@
* GHOST * GHOST
Rust bindings and Rust APIs for 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. 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. Rust-native API variants are made as well, which have non-prefixed names.
@ -74,7 +74,7 @@
- [ ] Events: ~event.rs~ - [ ] Events: ~event.rs~
***** Aliases ***** Aliases
- [X] /Handle types/ - [X] /Handle types/
**** Handles **** Handles
Handles keep the C ABI, but are re-wrtten with traits to be more idiomatic. 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. Keeping such a style is /usually/ preferred, anyhow.
See [[./src/error.rs][error.rs]] for more details. 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.

Loading…
Cancel
Save