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 10:06:47 +00:00
parent 00569e78dc
commit e59f5fd2be
1 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -29,6 +29,25 @@ To build from source, you'll also require:
You can also fetch a pre-compiled binary version of MFM. You can also fetch a pre-compiled binary version of MFM.
## Usage
### Command Line Options
```
Usage: mfm [options]
Global options:
-c, --config FILE Define configuration file
-h, --help Showcase this help
Commands:
create Instantiate a new vault
delete Erase an existing vault
edit Adjust the configuration
```
## Configuration ## Configuration
The script harnesses a YAML configuration file, typically located at `~/.config/mfm.yml`, which outlines vault names and paths. The script harnesses a YAML configuration file, typically located at `~/.config/mfm.yml`, which outlines vault names and paths.
@ -56,25 +75,6 @@ fsmap:
# Incorporate more vaults as necessary # Incorporate more vaults as necessary
``` ```
## Command Line Options
```
Usage: mfm [options]
Global options:
-c, --config FILE Define configuration file
-h, --help Showcase this help
Commands:
create Instantiate a new vault
delete Erase an existing vault
edit Adjust the configuration
```
## Usage
After setting up the YAML, activate the script. Employ `fzf` to pick a vault to mount or unmount.
## Contribution Guidelines ## Contribution Guidelines
To contribute to MFM: To contribute to MFM: