Add a README.md for documentation.

Removed the index.php file as this should be a simlink back to clock.php and git doesn't track it this way.
2020-04-10 14:19:10 -04:00
parent 6e85595081
commit ed4652ace1
2 changed files with 23 additions and 107 deletions
@@ -0,0 +1,23 @@
+# WebClock
+It's a clock. It runs in your browser.
+#### Description
+A simple clock for your web based timekeeping needs.
+Includes the abality to set the timezone you want if the one your browser chooes isn't what you need.
+The time will appear not only on the main page but also in the page's title so you can leave the page and still keep an eye on the time.
+#### Requierments
+```
+php - I'm running it on 5.6 so that or anything newer should work
+a webserver - I use apache. It's nice.
+A javascript interpriter - Basicaly a modernish webbrowser.
+```
+### Install
+1. git clone into a directory accessable by your webserver.
+	`git clone https://efrick.ddns.net/scm/git/WebClock`
+2.	Optional steps
+	1. Edit `clock.php` to point to your CSS files.
+	2. Add a symlink from `clock.php` to a file called `index.php`.
+	   `ln -s clock.php index.php`
+
+### ToDo
+- [ ] Add a timer.
+- [ ] Multiple clocks for tracking regions.