docs: update README.md
This commit is contained in:
parent
82177e4618
commit
aa4bc84c6b
16
README.md
16
README.md
|
@ -1,7 +1,21 @@
|
||||||
# Vaporise
|
# Vaporise
|
||||||
Vaporise (`vpr`) is a simple, featureful and memory-safe alternative to the common `rm`, and is written in pure Rust.
|
Vaporise (`vpr`) is a simple, featureful and memory-safe alternative to the common `rm`, and is written in pure Rust.
|
||||||
|
|
||||||
> This project is currently a work in progress, and I therefore make no guarantees on stability. There's a lot to be added, too.
|
> This project is relatively stable, and most of what I had planned in terms of features have been done.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To build `vaporise`, you'll need [Rust](https://rust-lang.org) installed:
|
||||||
|
```bash
|
||||||
|
$ git clone https://git.devraza.duckdns.org/devraza/vaporise
|
||||||
|
$ cd bunbun
|
||||||
|
$ cargo build --release # `--release` adds a few optimisations
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note that the executable command for this project is `vpr`.**
|
||||||
|
|
||||||
|
> **Using the flake!**
|
||||||
|
> This repository contains a `flake.nix` - if you have Nix installed, you can run `nix run github:devraza/vaporise` to compile and run the program.
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
A list of features (or anything else relevant), currently implenented and *not* implemented.
|
A list of features (or anything else relevant), currently implenented and *not* implemented.
|
||||||
|
|
Loading…
Reference in a new issue