diff --git a/cgt-cli/README.md b/cgt-cli/README.md index d716fa2..89f55a4 100644 --- a/cgt-cli/README.md +++ b/cgt-cli/README.md @@ -4,9 +4,7 @@ ## Installation -Once in a while when release is published, GNU/Linux and Windows pre-built binaries are published in the [releases tab](https://github.com/t4ccer/cgt-rs/releases/). GNU/Linux pre-built binaries have some problems on my system (See [Building from source](#building-from-source)), but Windows ones seems to work (confirmed with [Wine](https://www.winehq.org/)). - -### Building from source +### Building from source (Recommended) To build `cgt-cli` from source clone the repository and install [Rust toolchain](https://www.rust-lang.org/tools/install) (`rustc`, `cargo`). If you are using [Nix](https://nixos.org/) you can use `nix develop` to bootstrap the development environment for you. @@ -18,6 +16,13 @@ $ cargo build --package cgt-cli --release You will find the binary in `./target/release` directory created by `cargo`. +### Releases page + +> [!WARNING] +> There is no stable version of `cgt-cli` yet and releases are published very infrequently thus it is recommended to build from source. + +Once in a while when release is published, GNU/Linux and Windows pre-built binaries are published in the [releases tab](https://github.com/t4ccer/cgt-rs/releases/). GNU/Linux pre-built binaries have some problems on my system (See [Building from source](#building-from-source)), but Windows ones seems to work (confirmed with [Wine](https://www.winehq.org/)). + ## Usage Once you have `cgt-cli` you can use it to print available options. @@ -25,3 +30,9 @@ Once you have `cgt-cli` you can use it to print available options. ```console $ cgt-cli --help ``` + +You can furher call `cgt-cli` with `--help` on subcommands e.g. + +```console +cgt-cli snort --help +```