summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWubTheCaptain <wub@partyvan.eu>2015-09-18 05:32:38 +0200
committerpantsucat <contact@pantsu.cat>2015-09-18 06:29:52 +0200
commitdbc1450225a3ebc4633f4d3b76bb8ad133f6ace7 (patch)
tree0cda37e916a72ccae475c472430fe7ead6f1943c
parentf35494491e5b94752108059c6a7d68f4db95a9c6 (diff)
Fix README.md outline
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4cf35fe..87b9efb 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,11 @@
Original development environment is Nginx + PHP5.5 + MySQL, but is confirmed to work with Apache 2.4
and newer PHP versions. Should work with any other PDO-compatible database.
-# Install
+## 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.
-## Compiling
+### Compiling
The assets are minified and combined using [Grunt](http://gruntjs.com/).
Assuming you already have Node and NPM working, compilation is easy:
@@ -19,14 +19,14 @@ $ grunt
```
After this, the pomf site is now compressed and set up inside `dist/`.
-### Apache
+#### Apache
If you are running Apache and want to compress your output when serving files, add to your `.htaccess` file:
```
AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
```
Remember to enable `deflate_module` and `filter_module` modules in your Apache configuration file.
-## Configuring
+### Configuring
The majority of settings are in `static/includes/settings.inc.php`. Read the
comments in that file for more information.
@@ -42,5 +42,5 @@ Make sure to disable PHP from being executed on the file download domain/directo
* Clean up Moe code, a lot..
* API keys?
-# Contact
+## Contact
I can be contacted via hostmaster@pantsu.cat.