20xd6/WebClock
1
0
Fork 0
Code Issues Pull Requests Releases 2 Wiki Activity

Update to the Documentation.

Browse Source 
Added licensing to the README.md file. All code will be GPLv2.
This commit is contained in:
efrick 2020-04-23 23:26:54 -04:00
parent 6529a86a1e
commit b21b9e6891
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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._
- [ ] 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).