# Sampitor

![](https://github.com/scruffaluff/sampitor/workflows/build/badge.svg)
![](https://img.shields.io/github/repo-size/scruffaluff/sampitor)
![](https://img.shields.io/github/license/scruffaluff/sampitor)

---

**Documentation**: https://scruffaluff.github.io/sampitor

**Source Code**: https://github.com/scruffaluff/sampitor

---

Sampitor is a digital audio editor for the terminal build on top of
[TUI-RS](https://github.com/fdehau/tui-rs) and
[Rodio](https://github.com/RustAudio/rodio).

## Install

Sampitor provides compiled binaries for each GitHub release. You can install
Sampitor by visiting the latest
[release page](https://github.com/scruffaluff/sampitor/releases/latest),
downloading a release archive, extracting it, and copying the binary to a
directory in your system `PATH`.

If you have a Rust environment set up, you can also install with Cargo.

```console
cargo install sampitor
```

Cargo will compile Sampitor and place the binary file into `$HOME/.cargo/bin`.

## Contribute

For guidance on setting up a development environment and how to make a
contribution, see the
[Contributing Guide](https://github.com/scruffaluff/sampitor/blob/master/CONTRIBUTING.md).

## License

Sampitor is distributed under the
[MIT license](https://github.com/scruffaluff/sampitor/blob/master/LICENSE.md).