aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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`.