devraza/vaporise
1
Fork 0
Code Issues Pull requests Packages Projects Releases 3 Wiki Activity

docs: update README.md

Browse source
This commit is contained in:
Muhammad Nauman Raza 2024-04-12 09:20:15 +01:00
parent 0d81732582
commit 072a525631
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,7 +1,21 @@
# Vaporise
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
A list of features (or anything else relevant), currently implenented and *not* implemented.