/classroom-cli

Primary LanguageRubyMIT LicenseMIT

Classroom::Cli

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/classroom/cli. 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 'classroom-cli'

And then execute:

$ bundle

Or install it yourself as:

$ gem install classroom-cli

Usage

Cloning

The clone command will clone a set of repositories at once. The set of repositories is defined in a projects.yml file.

$ classroom clone

add a projects.yml file to your project directory containing the following example content:

projects:
- https://github.com/courseabc/xyz
- https://github.com/courseabc/opq

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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/[USERNAME]/classroom-cli.

License

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