README.markdown in binman-0.1.2 vs README.markdown in binman-1.0.0

- old
+ new

@@ -31,14 +31,18 @@ ------------------------------------------------------------------------------ Installation ------------------------------------------------------------------------------ -As a Ruby gem: +As a Ruby gem (without markdown to roff converter): gem install binman +As a Ruby gem (with extra cheese and everything please): + + gem install binman --development + As a Git clone: git clone git://github.com/sunaku/binman cd binman bundle install @@ -78,9 +82,19 @@ ### In your Rakefile Add the following line to your `Rakefile` and you've got a `binman` task! require 'binman/rake_tasks' + +It will pre-build UNIX man page files for your `bin/` scripts into a `man/` +directory so that your end-users do not need the markdown to roff converter +installed in order to view your man pages! Just remember to add the `man/` +directory's contents to your gemspec or release package: + + Gem::Specification.new do |s| + # ... your stuff ... + s.files += Dir['man/**/*'] + end ------------------------------------------------------------------------------ License ------------------------------------------------------------------------------