diff options
| author | Faraz Yashar <faraz.yashar@gmail.com> | 2015-05-07 17:22:45 -0400 |
|---|---|---|
| committer | Faraz Yashar <faraz.yashar@gmail.com> | 2015-05-07 17:22:45 -0400 |
| commit | 35b00ff104a01cb82d6a98749cfb1eab65011680 (patch) | |
| tree | 9f2845e14d2bf7e30367691ad27af42546cc1b86 | |
| parent | 73cec1c5b51dd6f9a7d6712ea6832f89ce9cb4f8 (diff) | |
| download | bundler-35b00ff104a01cb82d6a98749cfb1eab65011680.tar.gz | |
Add instructions for running tests; fixes #3596
| -rw-r--r-- | lib/bundler/templates/newgem/README.md.tt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/bundler/templates/newgem/README.md.tt b/lib/bundler/templates/newgem/README.md.tt index 45d901738f..765b1ac859 100644 --- a/lib/bundler/templates/newgem/README.md.tt +++ b/lib/bundler/templates/newgem/README.md.tt @@ -1,6 +1,6 @@ # <%=config[:constant_name]%> -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/<%=config[:namespaced_path]%>`. To experiment with that code, run `bin/console` for an interactive prompt. +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/<%=config[:namespaced_path]%>`. To experiment with that code, run `bin/console` for an interactive prompt.<% if %w[minitest rspec].include?(config[:test]) %> Run <% if config[:test] == 'rspec' %>`rake spec`<% else %>`rake test`<% end %> to run the test suite.<% end %> TODO: Delete this and the text above, and describe your gem @@ -26,7 +26,7 @@ TODO: Write usage instructions here ## Development -After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.<% if config[:bin] %> Run `bundle exec <%= config[:name] %>` to use the code located in this directory, ignoring other installed copies of this gem.<% end %> +After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.<% if config[:bin] %> Run `bundle exec <%= config[:name] %>` to use the code located in this directory, ignoring other installed copies of this gem.<% end %><% if %w[minitest rspec].include?(config[:test]) %> Run <% if config[:test] == 'rspec' %>`rake spec`<% else %>`rake test`<% end %> to run the test suite.<% end %> 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). |