Initial documentation

Author: ifmw

README.md

@@ -1,4 +1,44 @@
 phpMyReservation
 ================
 
-Fork of OleJohn's booking system
+Fork of [OleJon's](http://www.olejon.net) wonderful timeslot booking system for PHP and MySQL hosts.
+
+
+####Features
+    Fast, easy & smooth
+    User login
+    Browse through all weeks of the year
+    A price per reservation can be set
+    Usage is stored automatically
+    User control panel
+    Advanced admin control panel
+    Receive reservation reminders by email 
+    
+####Requirements
+
+#####Server:
+        Web server with PHP
+        MySQL 
+
+#####Client:
+        A modern browser 
+
+####Screenshots
+![1.0 reservation screen](doc/demo.png "1.0 reservation screen")
+![1.0 signup screen](doc/signup.png "1.0 signup screen")
+
+####Demo
+[This is a hosted demo of 1.0 of the project](http://www.olejon.net/code/phpmyreservation/?demo)
+
+####Installation
+1. Clone this repo
+2. Import phpmyreservation.sql into mysql or use phpMyAdmin
+3. Edit config.php. Secret code is 1234 by default. Set to 0 to disable.
+4. Move the phpmyreservation folder to where it can be reached through your web server
+5. If you chose to enable reservation reminders in config.php, read this to make it work
+6. Open phpMyReservation in a web browser. If you have done everything correctly, you should see the login page
+7. Create a new user. The first created user will get admin rights
+8. Set the price per reservation in the control panel (just set to 0 if usage is free) 
+
+####Reservation reminders
+[Email reminders are documented here](doc/ReservationReminders.md)

doc/ReservationReminders.md

@@ -0,0 +1,40 @@
+phpMyReservation Email Reminders
+================
+[Documentation from Google Code site](http://code.google.com/p/phpmyreservation/wiki/ReservationReminders)
+
+If you choose to enable reservation reminders in config.php, read the following carefully to make it work.
+
+Reservation reminders will be sent by email to those who have reservations the current day and have enabled reservation reminders in the control panel. The script that sends out reservation reminders is reminders.php, and the idea is to run the script daily (early in the morning).
+
+There are different ways to to this, depending on operating system etc.
+
+If you have access to the command line on the web server and the web server is running Linux (which it most likely does), you can do this:
+
+1) Log in to the command line on the web server
+
+2) Run these commands:
+
+  export EDITOR=nano
+  crontab -e
+
+3) Add this line
+
+ 0 6 * * * php /full/path/to/phpmyreservation/reminders.php
+
+This will run the script daily, at 06:00. Make sure that you use the correct path.
+
+4) Save with Ctrl+O and then return, exit with Ctrl+X
+
+If you don't have access to the command line:
+
+If you don't have access to the command line, your web host provider may have a control panel or similar where you can add scheduled events.
+
+If you have another computer/server that is running 24/7, you can set it up to run the reminders.php script daily over HTTP (for example using cron & cURL).
+
+To run the script over HTTP you must supply the code that you set in config.php (to avoid that everyone is able to run the script). You must run it like this:
+
+ http://your.server/phpmyreservation/reminders.php?code=CODE
+
+If it doesn't work
+
+There are several reasons why this may not work. Your web server may be unable to send emails (depending on your web host provider). If you're running phpMyReservation on domain.com, you should edit config.php to use whatever@domain.com (an email address that you own) as sender for reservation reminders, or else it may not work (rejected or marked as spam).