diff --git a/README.md b/README.md index 04b36cb..dfba989 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,34 @@ Simple Repository My simple php file repository/link tree that I wrote for my personal NAS. +Requirements +------------ + +To run this you will need: + +apache2 +php +make + How to use ---------- -I designed this with the intent that it could be used on something like a raspberry pi with little to no programming knowledge. +All setup can be done with make. It is recomended you first edit the config file. Above each section is an explanation of how to use it. To create a new config file, run: -The config file is supposed to be very easy to read and understand what each option means. The config file is in php. You will need to either rename or copy config.def.php to config.php +```bash +make new_config +``` -This is to make updating much much easier. +The config file can then be found at [var/config.php](var/config.php) -The config file is [var/config.php](var/config.php) +After you are done setting up your configuration file, run: + +```bash +make install +``` + +This will install the website and should now be accessible. If at any time you wish to update the config file, edit the config file in this folder, then run + +```bash +make update_config +```