2024-03-13 19:57:42 +00:00
|
|
|
# Vaporise
|
2024-04-12 09:47:52 +01:00
|
|
|
Vaporise (`vpr`) is a simple, featureful, fast, and memory-safe alternative to the common `rm`, written in pure Rust.
|
2024-03-13 19:57:42 +00:00
|
|
|
|
2024-05-19 11:20:32 +01:00
|
|
|
> This project is relatively stable, and most of what I have planned in terms of features have been done.
|
2024-04-12 09:20:15 +01:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
To build `vaporise`, you'll need [Rust](https://rust-lang.org) installed:
|
|
|
|
|
```bash
|
2024-05-24 13:07:57 +01:00
|
|
|
$ git clone https://git.devraza.giize.com/devraza/vaporise
|
2024-05-29 15:30:36 +01:00
|
|
|
$ cd vaporise
|
2024-04-12 09:20:15 +01:00
|
|
|
$ 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.
|
2024-03-13 19:57:42 +00:00
|
|
|
|
|
|
|
|
## 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
|
2024-04-12 09:56:21 +01:00
|
|
|
- [X] Doesn't delete `/` by default - **this is untested**
|
2024-04-02 16:45:38 +01:00
|
|
|
- [X] Prompting before every, or just the first, removal
|
2024-03-13 19:57:42 +00:00
|
|
|
- [ ] Trashing files through a CLI argument
|
