doc: add required dependencies & debian command
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
afb97e0a89
commit
47c9dbcd89
1 changed files with 21 additions and 3 deletions
24
README.md
24
README.md
|
@ -19,11 +19,27 @@ Before using MFM, make sure the following tools are installed on your system:
|
||||||
- **sshfs**: <https://github.com/libfuse/sshfs>
|
- **sshfs**: <https://github.com/libfuse/sshfs>
|
||||||
- **httpdirfs**: <https://github.com/fangfufu/httpdirfs>
|
- **httpdirfs**: <https://github.com/fangfufu/httpdirfs>
|
||||||
- **fzf**: <https://github.com/junegunn/fzf>
|
- **fzf**: <https://github.com/junegunn/fzf>
|
||||||
|
- libpcre3
|
||||||
|
- libevent-2.1
|
||||||
|
|
||||||
|
For Debian/Ubuntu you can use the following command:
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
$ sudo apt-get update && sudo apt-get install libpcre3 libevent-2.1-7 fzf gocryptfs httpdirfs sshfs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building from source
|
||||||
|
|
||||||
To build from source, you'll also need:
|
To build from source, you'll also need:
|
||||||
|
|
||||||
- **crystal-lang**: <https://crystal-lang.org/>
|
- **crystal-lang**: <https://crystal-lang.org/>
|
||||||
|
|
||||||
|
For Debian/Ubuntu you can use the following command:
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
$ sudo apt-get update && sudo apt-get install libpcre3-dev libevent-2.1-dev
|
||||||
|
```
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. From Source
|
### 1. From Source
|
||||||
|
@ -36,7 +52,8 @@ To build from source, you'll also need:
|
||||||
|
|
||||||
### 2. Binary Download
|
### 2. Binary Download
|
||||||
|
|
||||||
Alternatively, download [a pre-compiled binary version](https://code.apps.glenux.net/glenux/mfm/releases) of MFM.
|
Alternatively, download [a pre-compiled binary
|
||||||
|
version](https://code.apps.glenux.net/glenux/mfm/releases) of MFM.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -61,7 +78,8 @@ Commands (not implemented yet):
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
MFM uses a YAML configuration file, typically found at `~/.config/mfm.yml`, to detail the filesystem names, types, and respective configurations.
|
MFM uses a YAML configuration file, typically found at `~/.config/mfm.yml`, to
|
||||||
|
detail the filesystem names, types, and respective configurations.
|
||||||
|
|
||||||
### YAML File Format
|
### YAML File Format
|
||||||
|
|
||||||
|
@ -86,7 +104,7 @@ filesystems:
|
||||||
- type: httpdirfs
|
- type: httpdirfs
|
||||||
name: "Debian Repository"
|
name: "Debian Repository"
|
||||||
url: "http://ftp.debian.org/debian/"
|
url: "http://ftp.debian.org/debian/"
|
||||||
|
|
||||||
# Add more filesystems as needed
|
# Add more filesystems as needed
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue