From 47c9dbcd899ad963b657a49dd5aff910e68e3c86 Mon Sep 17 00:00:00 2001 From: Glenn Date: Thu, 2 Nov 2023 16:58:39 +0100 Subject: [PATCH] doc: add required dependencies & debian command --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 59d276c..bc58143 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,27 @@ Before using MFM, make sure the following tools are installed on your system: - **sshfs**: - **httpdirfs**: - **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: - **crystal-lang**: +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 ### 1. From Source @@ -36,7 +52,8 @@ To build from source, you'll also need: ### 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 @@ -61,7 +78,8 @@ Commands (not implemented yet): ## 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 @@ -86,7 +104,7 @@ filesystems: - type: httpdirfs name: "Debian Repository" url: "http://ftp.debian.org/debian/" - + # Add more filesystems as needed ```