diff options
Diffstat (limited to 'CLI/rust/README.md')
| -rw-r--r-- | CLI/rust/README.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/CLI/rust/README.md b/CLI/rust/README.md index bacb505..b7eba7c 100644 --- a/CLI/rust/README.md +++ b/CLI/rust/README.md @@ -39,6 +39,7 @@ OPTIONS: [](https://asciinema.org/a/ypprtuwwvQZXRuxZBB5XUNoic) ## Development +### Locally - Install rustup via `curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf | sh` - Install rust stable version for development `rustup update` - Install rust nightly for testing via `rustup install nightly` @@ -47,18 +48,22 @@ OPTIONS: - run `cargo build` to build the crate/CLI binaries. - run `cargo run --` to run the built binaries. +### Docker +- Build: `docker build . -t rust-gol` +- Run: `docker run -it -v .:/app rust-gol run --` + ## Linting -Run `cargo fmt -- --check` +Run `cargo fmt -- --check` or `docker run -it rust-gol cargo fmt -- --check` ## Testing -Run `cargo +nightly test` +Run `cargo +nightly test` or `docker run -it rust-gol cargo +nightly test` ## Documentation -Run `cargo doc` +Run `cargo doc` or `docker run -it -v .:/app rust-gol cargo doc` ## Release - Update the [version](./Cargo.toml) number -- Run `cargo build --release` and commit changes +- Run `cargo build --release` and commit changes (`docker run -it -v .:/app rust-gol cargo build --release`) - Update the [CHANGELOG](./CHANGELOG.md) - Create a git tag `rust/v#{version_number}` ex: `rust/v0.1.1-pre` |