diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d161f45df..48caed7d6 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.