<% chapter "Introduction" do %> <% project_summary do %> **<%= $project %>** is an infrastructure for [RubyGems](http://www.rubygems.org)-based software projects that encourages good documentation and reduces programming effort by automating common tasks. <% end %> **<%= $project %>** is exciting because: * It encourages good documentation: * Provides a comprehensive user manual that integrates release notes, setup and usage instructions, and more. * Automates the display of help, version, and usage information for your project's main executable. * It reduces programming effort: * Provides a single point of entry to your project's libraries. * Keeps your project's configuration in one place. * Parses command-line options using [the Trollop library](http://trollop.rubyforge.org). * It automates common tasks: * Generates project scaffolds while merging changes from previous ones. * Provides Rake tasks for packaging, publishing, and announcing your project. These features distinguish **<%= $project %>** from the competition: * [hoe](http://seattlerb.rubyforge.org/hoe/) * [newgem](http://newgem.rubyforge.org) * [Mr Bones](http://codeforpeople.rubyforge.org/bones/) * [Gemify](http://gitorious.org/projects/gemify/) * [Jeweler](http://technicalpickles.github.com/jeweler/) * [GemMake](https://simonmenke.github.com/gm/) * [SimpleGem](http://github.com/reagent/simple-gem/tree/master) <% paragraph "Etymology" do %> In the past, software development was thought to be like mathematical modeling or building construction: the assembly of inanimate objects. Nowadays, it is thought to be more like gardening: the cultivation of life! In this manner, I consider this project not as a generator of skeletons or as a builder of scaffolds, but as a *giver of life*. That is why I named this project "inochi", the Japanese word for *life*. Happy cultivation! <% end %> <% section "Logistics" do %> * <%= xref "History", "Release notes" %> --- history of project releases. * [Source code](http://github.com/sunaku/<%= $program %>) --- obtain via [Git](http://git.or.cz) or browse online. * [API reference](api/index.html) --- documentation for source code. * [Project home](<%= $website %>) --- the **<%= $project %>** project home page. To get help or provide feedback, simply <%= xref "License", "contact the author(s)" %>. <% paragraph "Version numbers" do %> **<%= $project %>** releases are numbered in *major.minor.patch* form according to the [RubyGems rational versioning policy](http://www.rubygems.org/read/chapter/7), which can be summarized thus:

What increased in the version number?	The increase indicates that the release:
	Is backward compatible?	Has new features?	Has bug fixes?
major	No	Yes	Yes
minor	Yes	Yes	Yes
patch	Yes	No	Yes

<% end %> <% end %> <% section "License" do %> <%# include ../LICENSE #%> <% end %> <% section "Credits" do %> <%= $logo = "".to_inline_xhtml %> <%# include README #%> **<%= $project %>** is made possible by <%= xref "History", "contributions" %> from users like you: * Florian Gilcher <% end %> <% end %>