README.markdown in binman-3.1.1 vs README.markdown in binman-3.2.0
- old
+ new
@@ -27,23 +27,23 @@
gem install binman
If you also want to build your own manual pages:
- gem install md2man -v '~> 1'
+ gem install md2man -v '~> 1.4'
### Prerequisites
* Ruby 1.8.7 or 1.9.2 or newer.
### Development
git clone git://github.com/sunaku/binman
cd binman
- bundle install --binstubs=bundle_bin
- bundle_bin/binman --help # run it directly
- bundle exec rake -T # packaging tasks
+ bundle install
+ bundle exec binman --help # run it directly
+ bundle exec rake --tasks # packaging tasks
## Usage
### At the command line
@@ -212,20 +212,21 @@
### Pre-building man pages
Add the following lines to your gemspec:
- s.files += Dir['man/**/*']
- s.add_development_dependency 'md2man', '~> 1'
+ s.files += Dir['man/man?/*.?']
+ s.add_development_dependency 'md2man', '~> 1.4'
Add the following line to your Rakefile:
require 'binman/rakefile'
You now have a `rake binman` task that pre-builds UNIX manual 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 manual pages you've embedded therein!
+There are also sub-tasks to build manual pages individually as [roff] or HTML.
If you're using Bundler, this task also hooks into its gem packaging tasks and
ensures that your UNIX manual pages are pre-built and packaged into your gem:
bundle exec rake build
@@ -233,9 +234,10 @@
## License
Released under the ISC license. See the LICENSE file for details.
+[roff]: http://troff.org
[binman]: https://github.com/sunaku/binman
[binman-api]: http://rubydoc.info/gems/binman/frames
[binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman
[md2man]: https://github.com/sunaku/md2man