Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Improve README documentation

  • Loading branch information...
commit 0fc851976346047dbffaf88689e57d985394cc4c 1 parent 2010089
@marklazz authored
Showing with 28 additions and 21 deletions.
  1. +1 −0  Manifest
  2. +26 −20 README.rdoc
  3. +1 −1  Rakefile
View
1  Manifest
@@ -6,6 +6,7 @@ USAGE.txt
bin/rtt
db/rtt.sqlite3
lib/rtt.rb
+lib/rtt/array_extensions.rb
lib/rtt/client.rb
lib/rtt/cmd_line_parser.rb
lib/rtt/hash_extensions.rb
View
46 README.rdoc
@@ -4,7 +4,14 @@ RTT - Ruby Time Tracker
RTT is a tool for tracking time. It's primary extend is to be used from command line. It could be used by simple typing:
-$ rtt start <task-name>
+How to start a task?
+--------------------
+
+$ rtt '<task-name>' ( or the more explicit way: 'rtt start <task-name>')
+
+That simple!
+
+If you start a task with the same name as one already stored for the very same day, then both task will be merged (suming the time of each one of those).
If no <task-name> is specified the last paused one is activated, otherwise a task with 'Default task' name would be created.
@@ -12,9 +19,7 @@ Then to stop the timer, you can do:
$ rtt stop | pause | resume (if there is a paused task)
-Also, by just typying: 'rtt start', without specifying the task, it would default to the previous task.
-
-If you start a task with the same name as one already stored for the very same day, then both task will be merged (suming the time of each one of those).
+Each new task belongs to a the current Project, Client and User. If there isn't any of those already configured, then the system will create them for you (you can change them later). Read 'More about the API' section.
Installation
------------
@@ -25,33 +30,25 @@ After installing the gem you will need to setup some basic information of yours
$ rtt configure user [<user-nick-name>]
-Then you will be prompt for First name, Last name, country, city, e-mail, site, etc. Information that will be used to fill-in the reports.
+Then you will be prompt for First name, Last name, country, city, e-mail, site, etc. Information that will be used to fill-in the reports.
The only required field is the Nickname, which identifies the user.
-To configure the current Project and Client you can use an analogous command:
-
-$ rtt configure project | rtt configure client
-
-After which, you'll be prompted for the attributes for those models.
+Note: This configuration step is not required, but if you don't do this your reports will lack any personal information.
-How to start a task?
---------------------
-$ rtt '<task-name>' ( or the more explicit way: 'rtt start <task-name>')
-..
+More about the API
+------------------
-That simple!
+To configure the current Project, Client or Task you can use an analogous command:
-Note: This command will create a task for the current configured user, project and client.
+$ rtt configure project [<project-name>] || rtt configure client [<client-name>] || rtt configure task [<task-name>]
-More about the API
-------------------
+After which, you'll be prompted for the attributes for those models.
-To change the current project. You can do this:
+If you just want to change the current project. You can do this:
$ rtt project <project-name>
-..
Anagolous, you can change the current Client by typing:
@@ -84,6 +81,15 @@ $ FROM=20-01-2010 TO=25-01-2010 CLIENT=SomeClient rtt report
The output for this command will produce a report only for the task started after 20th of January and before 25th of January and also that were produced for the client called 'SomeClient'.
+Also, You could filter not for a date range, but for a specifc date and/or for a user nickname, like this:
+
+$ DATE="20-01-2010" NICKNAME="marklazz" rtt report /home/marcelo/some_filename.pdf
+
+Final thoughts
+--------------
+
+Enjoy!
+
Questions/Comments
------------------
View
2  Rakefile
@@ -3,7 +3,7 @@ require 'echoe'
# PACKAGING ============================================================
-Echoe.new('rtt', '0.0.0.17') do |p|
+Echoe.new('rtt', '0.0.0.19') do |p|
p.description = 'RTT is a tool for tracking time'
p.url = 'http://github.com/marklazz/rtt'
p.author = 'Marcelo Giorgi'
Please sign in to comment.
Something went wrong with that request. Please try again.