summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Lejeck <peter.lejeck@gmail.com>2013-10-31 13:02:10 +0100
committerPeter Lejeck <peter.lejeck@gmail.com>2013-10-31 13:02:10 +0100
commit431357168b22a0c4a4f7dbd022e770cd2b734bdc (patch)
treee1e435efb88dfe5a68fd4e977a4c6208a536d6c3
parentc8f397851c437ef00ea168a819cef85864e3ade5 (diff)
Update README to reflect changes
-rw-r--r--README.md33
1 files changed, 29 insertions, 4 deletions
diff --git a/README.md b/README.md
index d8689c7..8546a4a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,32 @@
-Source code for Pomf.se
+# Pomf.se
+Only tested with Nginx + PHP5.5 + MySQL, but should work with newer PHP or any
+other PDO-compatible database.
-Code might work, or not. I might update this with the newest code, or not.
+# Install
+For the purposes of this guide, we won't cover setting up Nginx, PHP, MySQL,
+Node, or NPM. So we'll just assume you already have them all running well.
-Works best with Nginx+PHP5.5+MySQL.
+## Compiling
+The assets are minified and combined using [Grunt](http://gruntjs.com/).
-I can be contacted via neku@pomf.se or twitter at @nekunekus. \ No newline at end of file
+Assuming you already have Node and NPM working, compilation is easy:
+```
+$ npm install -g grunt-cli
+$ git clone https://github.com/nokonoko/Pomf.git
+$ cd Pomf
+$ npm install
+$ grunt
+```
+After this, the pomf site is now compressed and set up inside `dist/`.
+
+## Configuring
+The majority of settings are in `static/includes/settings.inc.php`. Read the
+comments in that file for more information.
+
+For file size configuration, there is no server-side verification: we assume
+that PHP and Nginx provide ample protection in this department. There is,
+however, client-side configuration for max size, the `data-max-size` attribute
+on the file input in `pages/upload_form.swig`.
+
+# Contact
+I can be contacted via neku@pomf.se or twitter at @nekunekus.