README.md in timetrap-1.15.2 vs README.md in timetrap-1.15.4

- old
+ new

@@ -11,10 +11,19 @@ $ gem install timetrap This will place a ``t`` executable in your path. +***UPDATE***: The current gem release seems to be having issues installing and the gem ownership on RubyGems.org is currently in the process of being transferred. Meanwhile, here is how to build the latest master from source: + + $ git clone https://github.com/samg/timetrap + $ cd timetrap + $ gem build timetrap + $ gem install timetrap_X.X.X.gem + +If you have errors while parsing the documentation, use `--no-document` option when installing the gem, or other option is to `gem install rdoc` before installing the `timetrap`. This is a known issue from [rdoc](https://github.com/ruby/rdoc/commit/5f9603f35d8e520c761015810c005e4a5beb97c3) + ### Basic Usage $ # get help $ timetrap --help $ # or @@ -62,11 +71,11 @@ Editing running entry You check out with the `out` command. $ t out - Checked out of sheet "coding" + Checked out of entry "document timetrap" in sheet "coding" Running `edit` when you're checked out will edit the last entry you checked out of. $ t edit --append "oh and that" @@ -510,18 +519,42 @@ ```bash fpath=(/path/to/timetrap-1.x.y/gem/completions/zsh $fpath) ``` #### Notes editing + If you use the note_editor setting, then it is possible to use an editor for writing your notes. If you use a non terminal based editor (like atom, sublime etc.) then you will need to make timetrap wait until the editor has finished. If you're using the "core.editor" flag in git, then it'll be the same flags you'll use. As of when this command was added, for atom you would use `atom --wait` and for sublime `subl -w`. If you use a console based editor (vim, emacs, nano) then it should just work. + +Development +----------- + +Get `bundler` in case you don't have it: + + gem install bundler + +Set a local path for the project's dependencies: + + bundle config set --local path 'vendor/bundle' + +Install timetrap's dependencies: + + bundle install + +Now you can run your local timetrap installation: + + bundle exec t + +Or run the test suite: + + bundle exec rspec Special Thanks -------------- The initial version of Timetrap was heavily inspired by Trevor Caira's