@@ -1,4 +1,4 @@ -Copyright (c) 2008 FIXME full name +Copyright (c) 2008 Lakshan Perera Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. License.txt @@ -4,10 +4,14 @@ Manifest.txt PostInstall.txt README.txt Rakefile +bin/todo config/hoe.rb config/requirements.rb lib/todo.rb lib/todo/version.rb +lib/todo/cli.rb +lib/todo/list.rb +lib/todo/store.rb script/console script/destroy script/generate @@ -16,8 +20,8 @@ setup.rb tasks/deployment.rake tasks/environment.rake tasks/website.rake -test/test_helper.rb -test/test_todo.rb +spec/todo_list_specs.rb +spec/todo_store_specs.rb website/index.html website/index.txt website/javascripts/rounded_corners_lite.inc.js Manifest.txt @@ -1,48 +1,58 @@ -= todo += Simple command-line todo list manager + +Really want to get things done? Don't want to juggle with web based todo lists? +Get your things done with command-line. No hassle, no distraction - Try out todo ruby gem. + + +== FEATURES: + +* Uses human readable YAML to store the todo lists (You could edit the todo list manually) +* Supportss project specific todo lists. (Just run 'todo create' in your project directory) +* Supports tagging. + +== Install + +First make sure you install the dependency gems. + sudo gem install main + sudo gem install highline + + then; + sudo gem install todo (should work) + + You can also install from git + git clone git://github.com/laktek/todo.git + cd todo + rake install_gem + +== Example: + + Here is a small sample on how to use todo gem + + #visit your project folder + cd projects/newapp + + #create a new todo list for the project + todo create + + #add a new task + todo add "write the specs" + - add tags : important, due:24/08/2008 + + #listing all tasks + todo list --all + + #listing tasks tagged 'important' + todo list --tag important + + #removing a task by name + todo remove "write the specs" + + #removing a task by index + todo remove -i 1 + +== Issues/Improvements + +Todo is still its infant days and have very minimum functionality. If you come across any issues or like to suggest any improvements, please feel free to contact me : lakshan [at] web2media [dot] net -* FIX (url) -== DESCRIPTION: -FIX (describe your package) - -== FEATURES/PROBLEMS: - -* FIX (list of features or problems) - -== SYNOPSIS: - - FIX (code sample of usage) - -== REQUIREMENTS: - -* FIX (list of requirements) - -== INSTALL: - -* FIX (sudo gem install, anything else) - -== LICENSE: - -(The MIT License) - -Copyright (c) 2008 FIXME full name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -'Software'), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file README.txt @@ -2,14 +2,12 @@ require 'todo/version' AUTHOR = 'Lakshan Perera' # can also be an array of Authors EMAIL = "lakshan@web2media.net" -DESCRIPTION = "a command line utility to manage todo lists" +DESCRIPTION = "simple command line todo list manager" GEM_NAME = 'todo' # what ppl will type to install your gem RUBYFORGE_PROJECT = 'todo' # The unix name for your project HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org" DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}" -EXTRA_DEPENDENCIES = [ -# ['activesupport', '>= 1.3.1'] -] # An array of rubygem dependencies [name, version] +EXTRA_DEPENDENCIES = [['main', '>= 2.8.2'], ['highline', '>= 1.4.0']] @config_file = "~/.rubyforge/user-config.yml" @config = nil @@ -61,7 +59,7 @@ $hoe = Hoe.new(GEM_NAME, VERS) do |p| # == Optional p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n") - p.extra_deps = [['main', '>= 2.8.2'], ['highline', '>= 1.4.0']] + p.extra_deps = EXTRA_DEPENDENCIES #p.spec_extras = {} # A hash of extra values to set in the gemspec. end config/hoe.rb @@ -49,7 +49,7 @@ Main { def run unless params['notags'].value - tags = ask("Enter tags for this item (seperate from commas)', (comma sep list)", lambda {|str| + tags = ask("Enter tags for this item (seperate from commas) ", lambda {|str| str.split(/,\s*/) }) end @@ -74,12 +74,13 @@ Main { argument('item'){ argument_optional - description 'name of the todo item to remove' + description 'Name of the todo item to remove' } option('index', 'i'){ cast :int argument :required + description 'Index of the todo item to remove (starting from 1). Use instead of item name' } def run lib/todo/cli.rb 252dca99f4899c0a4e218c3652b6d82960a3835a Lakshan Perera lakshan@web2media.net http://github.com/laktek/todo/commit/9bf70a6931eef5ef4eae322e7c7e1e1eb59b4db4 9bf70a6931eef5ef4eae322e7c7e1e1eb59b4db4 2008-08-25T19:08:16-07:00 2008-08-25T19:08:16-07:00 Added Readme 160198e6a3bfd25eb9273a53f22554a01e166f7a Lakshan Perera lakshan@web2media.net