sbrl-github/Pepperminty-Wiki
sbrl-github
/
Pepperminty-Wiki
mirror of https://github.com/sbrl/Pepperminty-Wiki.git
1
0
Fork 0
Code

Added build instructions to README.md

This commit is contained in:
Starbeamrainbowlabs 2014-12-26 10:27:33 +00:00
parent 3d054a965b
commit 1d289a1533
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -6,10 +6,18 @@ Pepperminty wiki is a complete wiki in a box inspired by @am2064's Minty wiki, w
Downloading / Installing
------------------------
### Quickstart
All you need to do is download `index.php` in this repository and put it in a folder on your web server. You need to make sure that PHP can write to that folder though. However, you can deny write access to the file itself since there is no automatic updating function built in yet.
If you prefer, you can clone this repository or use the "Download Zip" button to the right.
### Building
Pepperminty Wiki uses a simple PHP based build script. If you want to run this script yourself (for whatever reason), follow these instructions:
1. Clone this repository
2. Delete `index.php`.
3. Run `php build.php`.
Configuring
-----------
To configure it, open your downloaded copy of `index.php` in your favourite editor - the settings can be configured at the top of the file. There are extensive comments that explain what each option does. Make sure that you change the allowed usernames and passwords! If you need more help, don't hesitate to open an issue on this repository or contact me.