aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2021-11-09 12:54:36 +0100
committerDaniel Schadt <kingdread@gmx.de>2021-11-09 12:54:36 +0100
commit7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2 (patch)
treef45bd15196e20c3a6736e9972dac09d2d5e0f0a5
parentd21c5dc9c53b02620fce916ffc1a2695e9d3f698 (diff)
downloadmodderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.tar.gz
modderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.tar.bz2
modderbaas-7fbea3826e932cebd6c2f9883fe6ebdf8b08d6b2.zip
add a note about documentation to the readme
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 566ba4d..a3a635c 100644
--- a/README.md
+++ b/README.md
@@ -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`.