Skip to content
This repository was archived by the owner on Mar 30, 2024. It is now read-only.

Commit 3e1575b

Browse files
committed
„README.md“ ändern
1 parent fcafc70 commit 3e1575b

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
> Alpha Version, only works for Linux until now!
2-
> MacOS and Windows will be added soon
1+
> Alpha Version, only works for **Linux** and **Windows** until now!
2+
> MacOS will be added soon
33
# TaskTimeTerminate
44

55
> A Tool to record timings for tasks per category and rembering to terminate work sessions.
@@ -29,25 +29,28 @@ This tool tries to solve both problems at once:
2929
- Sync. stats and categories about multiple computers
3030

3131
## Setup
32-
Use the [`install.sh`](https://raw.githubusercontent.com/KIMB-technologies/TaskTimeTerminate/master/install.sh) (for linux and mac) or follow the steps:
32+
Use the [`install.sh`](https://raw.githubusercontent.com/KIMB-technologies/TaskTimeTerminate/master/install.sh)
33+
(for Linux and macOS) else follow the steps:
3334

3435
1. Install PHP 7.4 (only the CLI component is needed)
35-
- On Linux install `yad` for dialog windows
36-
- On Mac OS install `xxxxx` for dialog windows
37-
- No Support for Windows until now (but different dialog-windows are easy to add!)
38-
3. Download this repository, either via git or as zip and save to a folder
39-
4. Make executable `chmod +x ./record.php ./cli.php`
40-
5. Start `./cli.php` and add categories (e.g. Hobby, Work, Musts)
41-
- `./cli.php conf cats`
42-
6. Setup an autostart for `./record.php`
36+
- On Linux install `yad` for dialogs
37+
- On Windows PHP-GTK will be used (and downloaded on first run of `./cli.php r`)
38+
2. Download this repository, either via git or as zip and save to a folder
39+
3. Make executable `chmod +x ./record.php ./cli.php`
40+
4. Start `./cli.php` and add categories (e.g. Hobby, Work, Musts)
41+
- `./cli.php conf cats add`
42+
5. Setup an autostart for `./record.php`
4343
- The system needs a background process to check for limits and timeouts and to open dialogs
44-
7. Add a terminal shortcut to the `cli.php`
44+
6. Add a terminal shortcut to the `cli.php`
4545
- e.g. `echo "alias ttt='/home/user/my-full-path/to/cli.php'" >> ~/.bashrc`
46-
8. Add Times and Tasks while working
47-
9. Show stats `ttt s today`
46+
7. Add Times and Tasks while working
47+
8. Show stats `ttt s today`
4848

4949
### Data and Update
5050
Per default all data is saved in `~/.tasktimeterminate/`. This can be changed by editing the `config.json` in the programs
5151
root folder.
5252

53+
Per default all times use the timezone `Europe/Berlin`. This can be changed by editing the `config.json` in the programs
54+
root folder.
55+
5356
The program folder (not the data folder) can be deleted and replaced by a newer version. (If downloaded via git `git pull` should work.)

0 commit comments

Comments
 (0)