From b21b9e68912cb18b0c82c63d2e822263b1474c5d Mon Sep 17 00:00:00 2001 From: efrick Date: Thu, 23 Apr 2020 23:26:54 -0400 Subject: [PATCH] Update to the Documentation. Added licensing to the README.md file. All code will be GPLv2. --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bacf81e..f1bfaa6 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ A javascript interpriter - Basicaly a modernish webbrowser. 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 root CSS files. + 1. Edit `clock.php` to point to your root CSS files. _It points to a css file called `styles.css` in the root directory. If this is not your root css file please edit it._ 2. Add a symlink from `clock.php` to a file called `index.php`. - `ln -s clock.php index.php` + `ln -s clock.php index.php` _Most webservers will look for an index file (`index.html` or `index.php` for example) in any folder you open. Adding this symlink will inable you to link to the direcoty rather than `clock.php` without messing with the configuration of the webserver._ #### Note: There is a small privacy concern. Because this clock is using PHP to creat the inishal time entry and because this is using the `date()` function in PHP to do this it will reveal what timezone the server running it is set to. ### ToDo @@ -24,4 +24,8 @@ There is a small privacy concern. Because this clock is using PHP to creat the i - [x] Display original timezone's time. - [x] Display the offset of the two selected timezones. - [ ] Add a timer. -- [ ] Multiple clocks for tracking regions. _this is sort of implemented with the display original timezone feature but not compleatly and not how I want it._ \ No newline at end of file +- [ ] Multiple clocks for tracking regions. _this is sort of implemented with the display original timezone feature but not compleatly and not how I want it._ + +#### Licening +##### GPLv2 +A copy of the GPLv2 can be fond [here](https://efrick.ddns.net/GPLv2.txt). \ No newline at end of file