pdf-storycards

PDF StoryCards RDoc http://pdf-storycards.rubyforge.org/ Tracker http://rubyforge.org/projects/pdf-storycards/ by Luke Melia http://www.lukemelia.com/

== DESCRIPTION:

Provides a script and library to parse stories saved in the RSpec plain text story format and creates a PDF file with printable 3"x5" index cards suitable for using in Agile planning and prioritization.

== FEATURES/PROBLEMS:

• Create a PDF with each page as a 3x5 sheet, or as 4 cards per 8.5 x 11 sheet
• Included script reads stories from STDIN and writes PDF to STDOUT
• TODO: Improve test coverage
• TODO: Improve documentation

== SYNOPSIS:

From the command line with stories2cards < /path/to/stories.txt

Or via Ruby story_text = File.read('my_story') pdf_content = PDF::Storycards::Writer.make_pdf(story_text, :style => :card_1up)

== REQUIREMENTS:

• RSpec (for parsing stories)
• PDF::Writer (for creating PDFs)

== INSTALL:

sudo gem install pdf-storycards

== LICENSE:

(The MIT License)

Copyright (c) 2007-2008 Luke Melia

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.