glenux/mfm
glenux/mfm
1
0
Fork 1
Code Issues 21 Pull requests 5 Projects 1 Releases 2 Packages 1 Wiki Activity

Update README.md

Browse source
This commit is contained in:
Glenn Y. Rolland 2023-10-24 09:48:54 +00:00
parent ed3555c689
commit e061f6601d
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -2,9 +2,16 @@
GX-Vault Manager is a Crystal-lang script designed to simplify the management of encrypted vaults using `gocryptfs`. With its user-friendly interface, users can seamlessly mount and unmount vaults, get real-time vault status, and handle errors gracefully. GX-Vault Manager is a Crystal-lang script designed to simplify the management of encrypted vaults using `gocryptfs`. With its user-friendly interface, users can seamlessly mount and unmount vaults, get real-time vault status, and handle errors gracefully.
## Prerequisites ## Prerequisites & dependencies
- **gocryptfs**: Ensure you have `gocryptfs` installed on your system before using GX-Vault Manager. Ensure you have the following tools installed on your system before running GX-Vault:
- **gocryptfs**: <https://github.com/rfjakob/gocryptfs>
- **fzf**: <https://github.com/junegunn/fzf>
If you want to build from source, you'll also need:
- **crystal-lang** : <https://crystal-lang.org/>
## Installation ## Installation
@ -53,13 +60,6 @@ Commands:
Post YAML configuration, run the script. Use `fzf` to select a vault to mount or unmount. Post YAML configuration, run the script. Use `fzf` to select a vault to mount or unmount.
## Dependencies
- gocryptfs
- fzf
- Crystal-lang
- Additional Crystal-lang script dependencies
## Contribution Guidelines ## Contribution Guidelines
To contribute to GX-Vault Manager: To contribute to GX-Vault Manager: