You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -49,12 +51,77 @@ Grab the latest binary from the [releases page](https://github.com/TommyX12/rapi
49
51
50
52
### Development build
51
53
52
-
To run a live-reload debug build:
54
+
If you want to run a live-reload debug build for development:
53
55
54
56
```bash
55
57
npm start
56
58
```
57
59
58
-
## Usage
60
+
## Basic Usage
61
+
62
+
To add your first record:
63
+
- Open Rapid Time Tracker
64
+
- Click `New` to create a new data file (.txt)
65
+
- Click `Add` on the top left
66
+
- Enter a new action name
67
+
- Press `shift + enter` to create the new action, press `enter` again to confirm
68
+
- Press `enter`, modify duration (e.g. your preferred unit), press `enter` again to add the record.
69
+
70
+
### Opening a data file
71
+
72
+
When using the time tracker for the first time, simply create a new data file or open an existing one from the welcome page. The data file will be a txt file that you can freely edit and move (see the [data file](#the-data-file) section).
73
+
74
+
### Recording time
75
+
76
+
In Rapid Time Tracker, an **action** means an activity whose time is being tracked. A **record** means a particular session of this activity.
77
+
78
+
A record consists of:
79
+
- The action (i.e. activity) that is being done
80
+
- The time when the action finished
81
+
- The duration of the action in this session (can be in any unit you want, most commonly *hours*)
82
+
83
+
Click the `Add` button to add a new record.
84
+
85
+
86
+
87
+
Use the record dialog to enter the information. See the [fuzzy finder](#the-fuzzy-finder) section for tips and advanced usage.
88
+
89
+
90
+
91
+
To create a new action for this record, type a name for the action into the input box. You can also type a hierarchical name (e.g. `entertainment: games: minecraft`), separated by `:`. Once you typed the name, **press `shift + enter`** to create a new action with this name, then `enter` again to confirm.
92
+
93
+
94
+
95
+
Once an action is selected/created, press enter (while the input box is active) to confirm. Change the duration of the record if needed, then press enter again to finally create the record.
96
+
97
+
#### Note on hierarchy
98
+
99
+
Records can only be created for **leaf** actions, which are actions with no children. If an action is no longer leaf, a new child called `other` will be automatically created and all existing records on the parent will be moved to it.
100
+
101
+
### Visualization
102
+
103
+
#### Timeline
104
+
105
+
The timeline (on the left side) allows you to view records in chronological order. Use mouse wheel scrolling to move across timeline. You can also click on the records to edit them.
106
+
107
+
#### Tree
108
+
109
+
The tree (on the right side) allows you to view the total recorded amount for each action, in a hierarchical structure. Records for child actions, e.g. `entertainment: games: minecraft`, automatically count towards records for ancestors (e.g. `entertainment` and `entertainment: games`).
110
+
111
+
You can click on the actions to edit them.
112
+
113
+
114
+
115
+
To view the total recorded amounts in a given period of time, use the date range toolbar on the top. You can also select the units (e.g. `Per day`, `Per week`, `Percentage`) to display instead of the total.
116
+
117
+
118
+
119
+
A block-visualization of the record times is shown on the right most side, with vertical height of the blocks corresponding to the total recorded duration for the action. You can hover on the blocks to see the exact amounts (depending on the unit option) for the particular action.
0 commit comments