nostr/gossip
1
0
Fork 0
mirror of https://github.com/mikedilger/gossip.git synced 2024-09-29 16:31:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add file for generating rust doc

Browse Source
This commit is contained in:
Nicola Benaglia 2023-10-05 09:03:12 +02:00
parent 4c0c47d6fe
commit 9c9b6f4427
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/DOCUMENTATION.md Normal file
View 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
````