Skip to content

sophiedeziel/bkr

Repository files navigation

Bkr

Gem Version Build Status Join the chat at https://gitter.im/sophiedeziel/bkr

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/bkr. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Install the gem:

$ gem install bkr

Usage

bkr offers a CLI to automate some tasks of your project.

Start a new book project

In your terminal, move to the folder you want to create your book project in and run:

$ book new my_book_name

This will create a directory with some auto generated files and directories.

Development

After checking out the repo, run bundle install to install dependencies.

To install this gem onto your local machine, run bundle exec rake install.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/bkr/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

About

A framework for making interactive ePub3 books

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages