add readme

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..482d762
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Vault
+
+Vault is an opinionated web-based file manager. It is built in C for OpenBSD around the CGI standard, following these main principles:
+
+* __secure__: a great amount of time has been devoted to avoid undefined behaviour and security issues
+* __simple__: browse, create and delete folders; download and upload files. JavaScript support is optional on the client side and its absence should be handled gracefully. Everything should work from a terminal-based web browser
+* __fast__: with the server running on an ARM SBC, there should not be any noticeable delay when loading a page
+
+It should also compile and run on any POSIX OS with minor modifications, although this has not been tested (yet).
+
+## Configure
+
+The parameters and their documentation are in the `config.h` source file. You should read and adjust this file as needed before you build.
+
+## Build & run
+
+Vault comes with a Makefile:
+
+    $ make
+    # make install
+
+The vault binary will be installed as `/var/www/cgi-bin/vault`. You need to configure your web server accordingly. If the log file does not exist, you need to create it. Here is how to do it for a default installation:
+
+    # mkdir -p /var/www/var/log
+    # touch /var/www/var/log/vault.log
+    # chown www /var/www/var/log/vault.log