From fdb18af0912ddbc42d09ec6da1eb60b8f739f28d Mon Sep 17 00:00:00 2001
From: Falk Werner <falk.werner@gmx.net>
Date: Sun, 9 Feb 2020 16:44:54 +0100
Subject: [PATCH] chore: added description of dependencies

---
 README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 75 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 47d33f5..dd33c7a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,78 @@
 [![Build Status](https://travis-ci.org/falk-werner/webfused.svg?branch=master)](https://travis-ci.org/falk-werner/webfused)
 
 # webfused
-Reference implementation of webfuse daemon
+
+Reference implementation of webfuse daemon.
+
+## Build and run
+
+To install dependecies, see below.
+
+    cd webfused
+    mkdir build
+    cd build
+    cmake ..
+    make
+    ./webfused -m test --port=4711
+
+## Dependencies
+
+- [webfuse](https://github.com/falk-werner/webfuse)
+  - [libfuse](https://github.com/libfuse/libfuse/)
+  - [libwebsockets](https://libwebsockets.org/)
+  - [jansson](https://github.com/akheron/jansson)
+- [openssl](https://www.openssl.org/)
+
+### Installing dependencies
+
+#### libfuse
+
+To install libfuse, meson is needed. Please refer to [meson quick guide](https://mesonbuild.com/Quick-guide.html) for setup instructions.
+
+    wget https://github.com/libfuse/libfuse/archive/fuse-3.9.0.tar.gz -O fuse.tar.gz
+    tar -xf fuse.tar.gz
+    cd libfuse-fuse-3.9.0
+    mkdir .build
+    cd .build
+    meson ..
+    ninja
+    sudo ninja install
+
+#### libwebsockets
+
+    wget https://github.com/warmcat/libwebsockets/archive/v3.2.0.tar.gz -O libwebsockets.tar.gz
+    tar -xf libwebsockets.tar.gz
+    cd libwebsockets-3.2.0
+    mkdir .build
+    cd .build
+    cmake ..
+    make
+    sudo make install
+
+
+#### jansson
+
+    wget https://github.com/akheron/jansson/archive/v2.12.tar.gz -O jansson.tar.gz
+    tar -xf jansson.tar.gz
+    cd jansson-2.12
+    mkdir .build
+    cd .build
+    cmake ..
+    make
+    sudo make install
+
+#### openssl
+
+    sudo apt update
+    sudo install openssl libssl-dev
+
+#### webfuse
+
+    wget https://github.com/falk-werner/webfuse/archive/master.tar.gz -O webfuse.tar.gz
+    tar -xf webfuse.tar.gz
+    cd webfuse-master
+    mkdir .build
+    cd .build
+    cmake -DWITHOUT_TESTS=ON -DWITHOUT_EXAMPLE=ON ..
+    make
+    sudo make install