GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Docs: Updated goals

Browse source
This commit is contained in:
Paul Beckingham 2016-04-17 15:57:09 -04:00
parent 4c54441bba
commit 590aab02b9
2 changed files with 8 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

13
doc/intro.txt
View file

@ -10,9 +10,8 @@ tracking time:
$ timew stop $ timew stop
This will record a block of time as active, between the two timestamps that This will record a block of time as active, between the two timestamps that
were recorded when the 'start' and 'stop' commands were run. were recorded when the 'start' and 'stop' commands were run. By using tags, you
can label the blocks of active time:
By using tags, you can label the blocks of active time:
$ timew start Home Cleaning $ timew start Home Cleaning
... ...
@ -20,10 +19,8 @@ By using tags, you can label the blocks of active time:
This tags the block of time with the two tags 'Home' and 'Cleaning'. The tags This tags the block of time with the two tags 'Home' and 'Cleaning'. The tags
allow you to identify how you spent that time, and is used by the reporting allow you to identify how you spent that time, and is used by the reporting
system to summarize time. system to summarize time. You can also record time retroactively. If you forgot
ito start recording this morning, you can do this:
You can also record time retroactively. If you forgot to start recording this
morning, you can do this:
$ timew start 8:30am Home Cleaning $ timew start 8:30am Home Cleaning
@ -63,7 +60,7 @@ for example:
And the 'ProjectB' tagged interval will range from 2pm - 3pm. And the 'ProjectB' tagged interval will range from 2pm - 3pm.
Tags can have their own metadata, for example you can make a tag valid for a Tags may have their own metadata, for example you can make a tag valid for a
given time range: given time range:
$ timew config tag ProjectA end 2016-06-30 $ timew config tag ProjectA end 2016-06-30

8
doc/project.txt
View file

@ -21,22 +21,20 @@ Goals
friction. friction.
- Support all workflows. - Support all workflows.
- Provide an extension-friendly tool. - Provide an extension-friendly tool.
- Support policies via the rules system. - Support policies, events via the rules system.
- Integrate with Taskwarrior, Tasksh. - Integrate with Taskwarrior, Tasksh.
- Store data in plain UTF-8 text. - Store data in plain UTF-8 text.
Non-Goals Non-Goals
--------- ---------
- Completely independent from Taskwarrior, Taskserver, Tasksh. - No dependency on Taskwarrior, Taskserver and Tasksh.
- Time tracking is about recording the past, not planning the future. - Time tracking is about recording the past, not planning the future.
- No cloud support, no sync support, all data is local. Tracked time is - No cloud support, no sync support, all data is local. Tracked time is
sensitive personal data and will not be transmitted. sensitive personal data and will not be transmitted.
- No explicit multi-user support, although using tags to track individuals is - No explicit multi-user support, although using tags to track individuals is
possible. possible.
- There is no hook system as Timewarrior is a data sink, not a data source. - There is no hook system.
That said, there will be rules that can act as hooks, but will be more
flexible.
- No features without a compelling use case. - No features without a compelling use case.