From f865f67c773a3c3d304101c6ad8f19a8a8e03ca5 Mon Sep 17 00:00:00 2001 From: Josh North Date: Fri, 27 Feb 2015 15:39:23 -0500 Subject: [PATCH] update readme --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4c4cbcc..5c42a48 100755 --- a/README.md +++ b/README.md @@ -15,13 +15,22 @@ Free for use and modification. Credit is appreciated if you do anything with it This script is (as of today, 2015-02-26) in *fully-working beta status*. ### Theory: ### -TBA +We track time in this application by punching start and end times on each record. Times are calculated using MySQL math functions in the queries. This allows us to be more flexible with granularity and time zones, etc etc. Everything else is mostly in line with standard PHP web apps. ### Requirements: ### -TBA +* PHP (I used PHP 5.5.9) +* MySQL (I used MySQL 5.5.41) +* Web server (I used NGINX 1.4.6) ### Setup Assumptions: ### -TBA +* You have the above requirements met. +* You are somewhat familiar with editing PHP config files (I hope). +* I assume you have git installed - if not, rather than using the git-pull, download the zip from my git page. ### Setup Instructions: ### -TBA +1. Go to your webserver root as a user with write privileges (i.e. /usr/share/nginx/html) +2. Decide what sub-directory you want the app in. I use "timecard" here. +3. Run the following ``` +git clone https://github.com/joshnorth/yaptc.git timecard +``` +4.