Skip to content

Commit

Permalink
Doc: Add note on installation of CLI
Browse files Browse the repository at this point in the history
  • Loading branch information
coastalwhite committed Aug 23, 2023
1 parent 79ff6ea commit 3a2e8d6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/src/installation/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@
There is an official Command-Line Interface for wavedrom that can easily be
incorporated into scripts or workflows. This binary is available from the
[GitHub releases](https://github.com/coastalwhite/wavedrom-rs/releases).

A binary can be downloaded from here and be put into a location corresponding to
a operating system.

For Mac and Linux, `/usr/bin/local` is a good place to store the binary.

## Compilation from source

It is possible to compile from the GitHub directory. This generates the most
up-to-date binary, but may be less stable. This requires `git` and the Rust
toolchain `cargo` to be installed.

```bash
git clone https://github.com/coastalwhite/wavedrom-rs
cargo install --path=./wavedrom
```

0 comments on commit 3a2e8d6

Please sign in to comment.