mirror of
https://github.com/mikedilger/gossip.git
synced 2024-09-29 16:31:18 +00:00
Add file for generating rust doc
This commit is contained in:
parent
4c0c47d6fe
commit
9c9b6f4427
15
docs/DOCUMENTATION.md
Normal file
15
docs/DOCUMENTATION.md
Normal file
@ -0,0 +1,15 @@
|
||||
# DOCUMENTATION
|
||||
|
||||
You may want to generate the Gossip Rust Documentation from root folder:
|
||||
|
||||
````bash
|
||||
cargo doc --lib
|
||||
````
|
||||
|
||||
The output in `target/doc/gossip_lib/index.html` may be browsed.
|
||||
|
||||
For lasiest people the following will directly open the browser:
|
||||
|
||||
````bash
|
||||
cargo doc --lib --open
|
||||
````
|
Loading…
Reference in New Issue
Block a user