diff options
| author | felix <felix@seconddrawer.com.au> | 2011-05-16 08:52:08 +0000 |
|---|---|---|
| committer | felix <felix@seconddrawer.com.au> | 2011-05-16 08:52:08 +0000 |
| commit | 8f64d8e8d1534aed13c85a9a3420146ee1f63ebf (patch) | |
| tree | f84cc8898f2da63d611b4c45479b3e24b8862578 | |
| parent | 70b3632fd9e6ea2522ef86ff4eefecc49e449b84 (diff) | |
| download | timetrackr-8f64d8e8d1534aed13c85a9a3420146ee1f63ebf.tar.gz timetrackr-8f64d8e8d1534aed13c85a9a3420146ee1f63ebf.tar.bz2 | |
markdown readme
| -rw-r--r-- | README.mkd (renamed from README) | 40 |
1 files changed, 17 insertions, 23 deletions
@@ -2,39 +2,33 @@ A simple CLI time tracking utility. -## Contributing to timetrackr - -* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet -* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it -* Fork the project -* Start a feature/bugfix branch -* Commit and push until you are happy with your contribution -* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. -* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. +## Example -# commands + >tt start work -## timetracker start [task] + >tt switch play -- Start a new task 'task' at this time, 'default' if name not provided -- (config) Stop all other tasks and start 'task' + >tt + work 0h 0m 3s + play * 0h 0m 1s -## tt switch <task> + >tt clear work -- Stop all other tasks and start 'task' + >tt time + play * 0h 0m 1s -## tt stop [task] -- Stop 'task' if provided -- Stop all tasks if no 'task' -## tt time - -- List tasks and their times +## Contributing to timetrackr -## tt clear [task] +* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet +* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it +* Fork the project +* Start a feature/bugfix branch +* Commit and push until you are happy with your contribution +* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. +* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it. -- Delete 'task' or 'all' ## Copyright |