Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2026-08-29 10:08:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

More tweaks to Building/Development sections in README

Browse Source
This commit is contained in:
Marcin Kulik
2026-08-13 17:36:08 +02:00
parent 0b135e8de6
commit 14fce35475
1 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -86,10 +86,16 @@ overview.
## Building ## Building
Building asciinema from source requires the [Rust](https://www.rust-lang.org/) A native build of asciinema requires the Rust toolchain (1.82 or later) with
compiler (1.82 or later), and the [Cargo package Cargo. In a local checkout the recommended way to get it is the Nix dev shell,
manager](https://doc.rust-lang.org/cargo/). If they are not available via your which provides the complete toolchain and just works:
system package manager then use [rustup](https://rustup.rs/).
```sh
nix develop
```
If you don't use Nix, install Rust with Cargo via your system package manager
or [rustup](https://rustup.rs/).
To download the source code, build the asciinema binary, and install it in To download the source code, build the asciinema binary, and install it in
`$HOME/.cargo/bin` in one go run: `$HOME/.cargo/bin` in one go run:
@@ -134,14 +140,7 @@ generation (3.x) of the asciinema CLI, written in Rust.
The previous generation (2.x), written in Python, can be found in the `python` The previous generation (2.x), written in Python, can be found in the `python`
branch. branch.
The recommended way to work on asciinema is the Nix dev shell, which provides For toolchain setup and build instructions, see [Building](#building).
the complete toolchain and just works:
```sh
nix develop
```
If you don't use Nix, you need the Rust toolchain (1.82 or later) with Cargo.
If you'd like to propose or submit any changes, please read the If you'd like to propose or submit any changes, please read the
[contribution guidelines](CONTRIBUTING.md) first. [contribution guidelines](CONTRIBUTING.md) first.