README.markdown in binman-3.0.0 vs README.markdown in binman-3.0.1

- old
+ new

@@ -39,34 +39,26 @@ As a Ruby gem (with extra cheese and everything please): gem install binman --development -As a Git clone: +### Development git clone git://github.com/sunaku/binman cd binman - bundle install + bundle install --binstubs=bundle_bin + bundle_bin/binman --help # run it directly + bundle exec rake -T # packaging tasks ------------------------------------------------------------------------------ -Invocation +Usage ------------------------------------------------------------------------------ -If installed as a Ruby gem: +### At the command line - binman + binman --help -If installed as a Git clone: - - bundle exec ruby -Ilib bin/binman - -Just pass `--help` to see its man page. - ------------------------------------------------------------------------------- -Usage ------------------------------------------------------------------------------- - ### In your bin/ scripts Add the following lines to your bin/ script and you've got `--help` options! require 'binman' @@ -77,27 +69,29 @@ require 'binman' BinMan.show # just show the man page; no fancy extras, please! See the [API documentation][binman-api] for more delicious recipes. -### In your Rakefile +### Pre-building man pages -Add the following line to your `Rakefile` and you've got a `binman` task! +Add the following lines to your gemspec: - require 'binman/rakefile' + s.files += Dir["man/**/*"] + s.add_development_dependency 'md2man', '~> 1' -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! +Add the following line to your Rakefile: -### In your gemspec + require 'binman/rakefile' -To automatically build and include your UNIX man page files in your gem -packages, add the following line to the top of your `*.gemspec` file: +You now have a `rake binman` task that pre-builds UNIX man page files for your +`bin/` scripts into a `man/` directory so that your end-users do not need +[md2man] installed in order to view the man pages you've embedded therein! - require 'binman/gemspec' +If you're using Bundler, this task also hooks into its gem packaging tasks and +ensures that your UNIX man page files are pre-built and included in your gem: -Doing this also adds binman as a runtime and development gem dependency. + bundle exec rake build + gem spec pkg/*.gem | fgrep man/man ------------------------------------------------------------------------------ License ------------------------------------------------------------------------------