Skip to content

kristenmills/to-do

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#to-do 1.3.1 Gem Version Build Status Dependency Status Code Climate

A simple command line todo application written in Ruby.

What's new in 1.3.1

  • Bug Fixes
  • Text color adjustments for dark and light color schemes
  • Add a default list automatically as opposed to the message that tells you to create a default list

##What's new in 1.3

  • Priorities
  • Sorting

##Install gem install to-do

##Features

  • Basic todo list functionality
    • Add items
    • Complete items
    • Clear list
    • Display list
  • Multiple lists
  • Colored display
  • Undo Completing
  • Remove lists
  • Sortable
  • Priorities

##How to Use This is just basic usage. For more information, view todo -h todo --help

###Create a new todo list or switch to an existing list

todo create My New Todo List
todo switch My Existing List

###Add some tasks to the current list

todo add Cook Dinner
todo add Write Paper
todo a Do Laundy
todo a Clean Things

###Display the current list

todo display
todo d

********************************
        My New Todo List       
********************************

1. Cook Dinner
2. Write Paper
3. Do Laundry
4. Clean Things

Completed:					0/4

###Finish a task todo finish -n 2 todo f Clean Things

********************************
        My New Todo List       
********************************

    1. Cook Dinner
    3. Do Laundry

Completed:					2/4
    2. Write Paper
    4. Clean Things

###Undo completing a task todo undo write paper todo u -n 2

###Clear completed tasks and reset completed count

todo clear

###Clear the entire list and reset the count

todo clear -a

###Delete a list

todo remove My New Todo List
todo rm My Existing list

###View usage details

todo -h
todo --help

###View version todo -v todo --version

##Future Plans

  • Tags
  • Due Dates
  • Tab Completion
  • Reorganizing

##Similar Projects

  • timetrap is hip. You should probably check it out.
  • tracking is also pretty hip. You should probably check it out.

##Contributing to to-do

  • 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.

##Copyright

Copyright (c) 2012 Kristen Mills. See LICENSE.txt for further details.