Skip to content

Commit

Permalink
Add more docs to CLI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
t4ccer committed Jul 29, 2024
1 parent 43d613e commit 9756022
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions cgt-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -18,10 +16,23 @@ $ 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.

```console
$ cgt-cli --help
```

You can furher call `cgt-cli` with `--help` on subcommands e.g.

```console
cgt-cli snort --help
```

0 comments on commit 9756022

Please sign in to comment.