aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..0612ac3
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,17 @@
+# filmoteca
+
+1. Read doc/filmoteca.pdf
+2. Create a file tree just like the one described
+3. Run `filmoteca -d /your/filmoteca -a /your/assets -p 8080'
+4. Enjoy
+
+# Styling
+
+This is what the `-a assetsdir' option is for, you can put a
+`style.css' and a `favicon.ico' for the filmoteca to send, usually to
+web browser clients.
+
+# BUGS
+
+Any problems, errors, misbehavior you might find, please contact the
+author.