1
0
Fork 0
mirror of https://git.sr.ht/~nixgoat/vento synced 2024-11-16 12:02:49 +00:00
vento/README.md
Lux Aliaga aa233555a4
readme: Update quickstart
I know this is not accurate yet but I want to not bother with this
later.
2022-09-24 22:56:44 -03:00

1.2 KiB

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.

Install

Clone the repository using Git.

$ git clone https://codeberg.org/nixgoat/vento.git && cd vento

The recommended method to install Vento is to use cargo-make. This will install the binary and the manpages for Vento.

$ cargo make install

Otherwise you can build and install it with Cargo. This will however not install the manpages.

$ cargo install --path .

Quickstart

After installing, run vento -i. This will create a .vento folder in your home directory which will store your inventories. After which, you can run vento to display the files in your inventories, take to move a file into your active inventory and drop to drop a file out of it. If you're stuck, run vento help or check the manpage by running man vento.

Credits

  • Chesapeake for the original concept
  • jo! for helping me with Rust concepts!