1
0
Fork 0
mirror of https://git.sr.ht/~nixgoat/vento synced 2024-11-16 03:53:04 +00:00
vento/README.md
Lux Aliaga edcf1408ee
readme: Credit jo!
Seriously, couldn't have done it without her lol
2022-09-19 00:32:00 -03:00

22 lines
930 B
Markdown

![Vento](assets/logo.png "Vento")
Vento is a utility which allows you to manage your files as if you're playing an old text adventure. It's made in Rust and originally inspired by [Chesapeake's Inventory](https://github.com/mothdotmonster/inventory).
## Install
Clone it using Git and build it with [Cargo](https://rustup.rs/)!
```
$ git clone https://codeberg.org/nixgoat/vento.git && cd vento
$ cargo install --path .
```
## Quickstart
After installing, run `vento init`. This will create a `.vento` folder in your home directory which will store your inventories. After which, you can run `vento list` to display the files in your inventories, `vento take` to move a file into your active inventory and `vento drop` to drop a file out of it. If you're stuck, run `vento help`.
## Credits
- [Chesapeake](https://moth.monster/) for the original concept
- [jo!](https://codeberg.org/j0) for helping me with Rust concepts!