Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
redac
  • Loading branch information
framboise-pi authored Jun 11, 2023
1 parent 51e80a1 commit 8937f0e
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,37 @@ It contains a mi french/english syntax as this is how I code for myself XD
## Install notes
- copy all the files on your server
- create a database
- import skolkov_empty.sql
- edit the config.php file (/core/config/config.php)
- browse to your directory
- add a new user

## Usage
You can run as many timers as you want at the same time,
you can not creat a timer if there is no task to link to.

1. create a task
2. choose a task and start a timer
3. stop a timer

Total time spent on each tasks is displayed.
There are 4 pages:
1. version info
2. settings - you can change/edit your avatar
3. timers - see active timers and archived ones
4. tasts - add a task - see activ tasks and archived

## config.php
- database login informations
- if adding a new user is true/false

## libraries or else included
- google fonts
- bootstrap 5
- font awesome 5.14
- multiavatar


# TODO
A version/info page is included.
- [x] tested on PHP 8.2
Expand Down

0 comments on commit 8937f0e

Please sign in to comment.