diff options
author | Daniel Schadt <kingdread@gmx.de> | 2021-11-09 12:54:36 +0100 |
---|---|---|
committer | Daniel Schadt <kingdread@gmx.de> | 2021-11-09 12:54:36 +0100 |
commit | 7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2 (patch) | |
tree | f45bd15196e20c3a6736e9972dac09d2d5e0f0a5 | |
parent | d21c5dc9c53b02620fce916ffc1a2695e9d3f698 (diff) | |
download | modderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.tar.gz modderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.tar.bz2 modderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.zip |
add a note about documentation to the readme
-rw-r--r-- | README.md | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -10,12 +10,16 @@ The build process is done through `cargo`: cargo build --release ``` +The binary will reside in `target/release/`. + Library documentation can be built through ``` -cargo doc +cargo doc -p modderbaas ``` +Note that the crate is split into a workspace, running `cargo doc` without `-p` will give you the wrong documentation! + ## Usage See `modderbaas help`. |