Skip to content

doc(build): Update build and release documentation #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Antiz96 merged 1 commit into from
May 7, 2026
Merged

doc(build): Update build and release documentation #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,16 @@ In the mean time, things *should* still work just fine for most "classic" setups
### Pre-compiled binary

A pre-compiled binary for the `x86_64 (amd64)` architecture is distributed as a [release asset](https://github.com/Antiz96/oniri/releases/latest) (`oniri-<version>-amd64`).
You can download it, make it executable, rename it `oniri` and copy it somewhere in your `$PATH`.

### Build from source

Requires `rustup` and `gcc`.

```bash
git clone https://github.com/Antiz96/oniri.git
cd oniri
cargo build --release
```

The built binary will be located at `./target/release/oniri`.
You can copy it somewhere in your `$PATH`.

The man page can be generated with `scdoc`:

Expand Down
3 changes: 1 addition & 2 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

- `git-cliff`
- `github-cli`
- `gcc`
- `rustup`
- `cargo`

## Disable the main branch protection rule temporarily

Expand Down