Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-15 19:28:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document artifact generation

Browse Source
This commit is contained in:
Marcin Kulik
2024-04-29 22:34:23 +02:00
parent 39d46c0dae
commit 3bcdf3f744
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -69,8 +69,19 @@ cargo build --release
```
This produces the binary in _release mode_ (`--release`) at
`target/release/asciinema`. There are no other build artifacts so you can just
copy the binary to a directory in your `$PATH`.
`target/release/asciinema`. You can just copy the binary to a directory in your
`$PATH`.
To generate man page and shell completion files, set `ASCIINEMA_GEN_DIR` to the
path where these artifacts should be stored. For example:
```sh
ASCIINEMA_GEN_DIR=/foo/bar cargo build --release
```
The above command will build the binary and place the man page in
`/foo/bar/man/asciinema.1`, and the shell completion files in the
`/foo/bar/completion/` directory.
> [!NOTE]
> Windows is currently not supported. _(See [#467](https://github.com/asciinema/asciinema/issues/467))_