gossip/docs/DOCUMENTATION.md

16 lines
291 B
Markdown
Raw Normal View History

2023-10-05 07:03:12 +00:00
# DOCUMENTATION
You may want to generate the Gossip Rust Documentation from root folder:
````bash
2023-10-05 22:36:18 +00:00
cargo doc --lib
2023-10-05 07:03:12 +00:00
````
The output in `target/doc/gossip_lib/index.html` may be browsed.
For lasiest people the following will directly open the browser:
````bash
2023-10-05 22:36:18 +00:00
cargo doc --lib --open
2023-10-05 07:03:12 +00:00
````