From 072a52563161ebb9fa52eccbd6a3241b78c1c135 Mon Sep 17 00:00:00 2001 From: Muhammad Nauman Raza Date: Fri, 12 Apr 2024 09:20:15 +0100 Subject: [PATCH] docs: update README.md --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d38fd91..1aa70c8 100644 --- a/README.md +++ b/README.md @@ -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.