diff --git a/docs/DOCUMENTATION.md b/docs/DOCUMENTATION.md new file mode 100644 index 00000000..95dc0bab --- /dev/null +++ b/docs/DOCUMENTATION.md @@ -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 +````