Skip to content

Commit

Permalink
some explanation and a version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin Beddingfield authored and Kevin Beddingfield committed Mar 23, 2012
1 parent c2ed29b commit 65f320d
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 15 deletions.
27 changes: 25 additions & 2 deletions README.md
@@ -1,5 +1,28 @@
[![Build Status](https://secure.travis-ci.org/chumpy/calamity.png)](http://travis-ci.org/chumpy/calamity)

# calamity
A life hacking tool for the command line.
# Calamity
A GTD life hacking tool for the command line.

Keep track of tasks and organize them into contexts and projects

## Install
````
$ gem install calamity
````

## Use
usage: calamity [global options] command [command options]

Version: 0.0.2

Global Options:
--database="database" - The database file location (default:
/Users/kevinbeddingfield/.calamity/calamity.db)
--help - Show this message

Commands:
finish - Mark a task or tasks finished
help - Shows list of commands or help for one command
list - List unfinished tasks
save - Save a task, either to create a new one or update an existing one

5 changes: 2 additions & 3 deletions Rakefile
Expand Up @@ -4,9 +4,8 @@ require 'rubygems/package_task'
require 'rdoc/task'

Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
rd.title = 'Your application title'
rd.rdoc_files.include("lib/**/*.rb","bin/**/*")
rd.title = 'Calamity'
end

spec = eval(File.read('calamity.gemspec'))
Expand Down
6 changes: 3 additions & 3 deletions bin/calamity
Expand Up @@ -29,18 +29,18 @@ version Calamity::VERSION

desc 'The database file location'
default_value "#{ENV['HOME']}/.calamity/calamity.db"
arg_name '<database>'
arg_name '"database"'
flag [:database]

desc 'Save a task, either to create a new one or update an existing one'
arg_name '<task name>'
command :save do |c|
c.desc 'The context where the task will be accomplished'
c.default_value 'inbox'
c.arg_name '<context>'
c.arg_name '"context"'
c.flag [:c, :context]
c.desc 'The project the taske contributes to'
c.arg_name '<project>'
c.arg_name '"project"'
c.flag [:p, :project]
c.action do |global_options,options,args|
task = Calamity::Task.new
Expand Down
Binary file added calamity-0.0.1.gem
Binary file not shown.
6 changes: 3 additions & 3 deletions calamity.gemspec
Expand Up @@ -5,7 +5,7 @@ spec = Gem::Specification.new do |s|
s.version = Calamity::VERSION
s.author = 'Kevin Beddingfield'
s.email = 'kevin.beddingfield@gmail.com'
s.homepage = 'http://kevinbeddingfield.com'
s.homepage = 'http://github.com/chumpy/calamity'
s.platform = Gem::Platform::RUBY
s.summary = 'A life hacking tool'
# Add your other files here if you make them
Expand All @@ -14,8 +14,8 @@ bin/calamity
)
s.require_paths << 'lib'
s.has_rdoc = true
s.extra_rdoc_files = ['README.rdoc','calamity.rdoc']
s.rdoc_options << '--title' << 'calamity' << '--main' << 'README.rdoc' << '-ri'
s.extra_rdoc_files = ['calamity.rdoc']
s.rdoc_options << '--title' << 'calamity' << '--main' << '-ri'
s.bindir = 'bin'
s.executables << 'calamity'
s.add_development_dependency('rake')
Expand Down
3 changes: 0 additions & 3 deletions calamity.rdoc
@@ -1,5 +1,2 @@
= calamity

Generate this with
calamity rdoc
After you have described your command line interface
2 changes: 1 addition & 1 deletion lib/calamity_version.rb
@@ -1,3 +1,3 @@
module Calamity
VERSION = '0.0.1'
VERSION = '0.0.2'
end

0 comments on commit 65f320d

Please sign in to comment.