Skip to content

Latest commit

 

History

History
59 lines (31 loc) · 2.17 KB

README.md

File metadata and controls

59 lines (31 loc) · 2.17 KB

leg

Command line tool that helps you make step-by-step programming walkthroughs.

NOTE: This project is in a very unstable state at the moment. If you really want to use the last "stable" version of this project, head over to the snaptoken branch. (Just know that it will be replaced by a completely new tool and file format in the near future.)

Install

$ gem install leg

Usage

See the tutorial!


Leg

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/leg. To experiment with that code, run bin/console for an interactive prompt.

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

Installation

Add this line to your application's Gemfile:

gem 'leg'

And then execute:

$ bundle

Or install it yourself as:

$ gem install leg

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yjerem/leg. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Leg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.