summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2020-12-05 04:50:41 +0000
committerDan Davison <dandavison7@gmail.com>2020-12-05 04:50:41 +0000
commitbeb700f88974420d36cad494b1fac80de3e01093 (patch)
treee641832ec055d383c7c839f467c634ef8a0d17bd
parentd0b5262fa34549d006c3b69b87e7aef087ae9056 (diff)
Recommend release build in CONTRIBUTING.org
-rw-r--r--CONTRIBUTING.md20
1 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d161f45d..48caed7d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,15 +14,17 @@ This is no different than other Rust projects.
```shell
git clone https://github.com/dandavison/delta/
cd delta
-cargo build
+cargo build --release
```
+The executable is then at `./target/release/delta`.
+
### Useful Commands
-- Build release version:
+- Run all tests:
```shell
- cargo build --release
+ make test
```
- Run Clippy:
@@ -31,12 +33,6 @@ cargo build
cargo clippy
```
-- Run all tests:
-
- ```shell
- make test
- ```
-
- Check to see if there are code formatting issues
```shell
@@ -48,3 +44,9 @@ cargo build
```shell
cargo fmt
```
+
+- Debug build
+
+A "debug" build can be built using `cargo build` and
+`./target/debug/delta`. This is faster to compile, but has much worse
+performance than the release build.