vaporise/README.md

28 lines
1 KiB
Markdown

# Vaporise
Vaporise (`vpr`) is a simple, featureful, fast, and memory-safe alternative to the common `rm`, written in pure Rust.
> 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.
- [X] Deleting directories
- [X] Deleting files
- [X] User-friendly error handling
- [X] Doesn't delete `/` by default - **this is untested**
- [X] Prompting before every, or just the first, removal
- [ ] Trashing files through a CLI argument