11# Ruby Gem Skeleton
22
3- <!--
4- [](https://rubygems.org/gems/replace_gemname)
5- -->
3+ [ ![ Gem] ( https://img.shields.io/gem/v/makenew-ruby_gem.svg )] ( https://rubygems.org/gems/makenew-ruby_gem )
64[ ![ GitHub license] ( https://img.shields.io/github/license/makenew/ruby-gem.svg )] ( ./LICENSE.txt )
75[ ![ Gemnasium] ( https://img.shields.io/gemnasium/makenew/ruby-gem.svg )] ( https://gemnasium.com/makenew/ruby-gem )
86[ ![ Travis] ( https://img.shields.io/travis/makenew/ruby-gem.svg )] ( https://travis-ci.org/makenew/ruby-gem )
97[ ![ Codecov] ( https://img.shields.io/codecov/c/github/makenew/ruby-gem.svg )] ( https://codecov.io/github/makenew/ruby-gem )
108[ ![ Code Climate] ( https://img.shields.io/codeclimate/github/makenew/ruby-gem.svg )] ( https://codeclimate.com/github/makenew/ruby-gem )
119
12- Use this project freely as a base for your testable Ruby gems.
13-
1410## Description
1511
12+ Bootstrap a new [ Ruby] gem in less than a minute.
13+
14+ [ Ruby ] : https://www.ruby-lang.org/
15+
1616### Features
1717
1818* [ Rake] and [ Guard] tasks for included tools.
@@ -35,43 +35,23 @@ Use this project freely as a base for your testable Ruby gems.
3535[ Travis CI ] : https://travis-ci.org/
3636[ YARD ] : http://yardoc.org/index.html
3737
38- ### Usage
39-
40- This software can be used freely, see [ The Unlicense] .
41- The MIT License text appearing in this software is for
42- demonstration purposes only and does not apply to this software.
38+ ### Bootstrapping a New Project
4339
44401 . Clone this repository or download a [ release] [ Releases ] .
4541
46- 2 . Customize this README .
47- - Set the title and summary text.
48- - Replace the Description section .
49- - Update the Contributing section .
50- - Remove or update the badges .
42+ 2 . Run ` ./makenew.sh ` and follow the prompts .
43+ This will replace the boilerplate, delete itself,
44+ and stage changes for commit .
45+ This script assumes the project repository will be hosted on GitHub .
46+ For an alternative location, you must update the URLs manually .
5147
52- 3 . Everything else that should be filled in before using this skeleton
53- has been marked with the terms ` replace ` or ` Replace ` .
54- You can replace the placeholder gem name with your own using
48+ 3 . Fill in the README Description section.
5549
56- ```
57- $ git mv replace_gemname.gemspec your_gemname.gemspec
58- $ git mv lib/replace_gemname.rb lib/your_gemname.rb
59- $ git mv lib/replace_gemname lib/your_gemname
60- $ git ls-files -z | xargs -0 sed -i 's/replace_gemname/your_gemname/g'
61- $ git ls-files -z | xargs -0 sed -i 's/ReplaceGemname/YourGemname/g'
62- ```
63-
64- To see a list of what else still needs to be replaced, run
65-
66- ```
67- $ grep -Ri replace
68- $ find . -name "*replace*"
69- ```
70-
71- Note that ` CHANGELOG.md ` is just a template for this skeleton.
72- The actual changes for this project are documented in the commit history
73- and summarized under [ Releases] .
50+ 4 . If [ choosing a license] [ Choose a license ] other than the one provided:
51+ update ` LICENSE.txt ` , the README License section, and the gemspec file
52+ with your chosen license.
7453
54+ [ Choose a license ] : http://choosealicense.com/
7555[ Releases ] : https://github.com/makenew/ruby-gem/releases
7656[ The Unlicense ] : http://unlicense.org/UNLICENSE
7757
@@ -102,12 +82,18 @@ $ git fetch upstream
10282$ git merge upstream/master
10383```
10484
85+ #### Changelog
86+
87+ Note that ` CHANGELOG.md ` is just a template for this skeleton.
88+ The actual changes for this project are documented in the commit history
89+ and summarized under [ Releases] .
90+
10591## Installation
10692
10793Add this line to your application's [ Gemfile] [ Bundler ]
10894
10995``` ruby
110- gem ' replace_gemname '
96+ gem ' makenew-ruby_gem '
11197```
11298
11399and update your bundle with
@@ -119,7 +105,7 @@ $ bundle
119105Or install it yourself with
120106
121107```
122- $ gem install replace_gemname
108+ $ gem install makenew-ruby_gem
123109```
124110
125111[ Bundler ] : http://bundler.io/
@@ -129,28 +115,28 @@ $ gem install replace_gemname
129115- [ YARD documentation] [ RubyDoc ] is hosted by RubyDoc.info.
130116- [ Interactive documentation] [ Omniref ] is hosted by Omniref.
131117
132- [ RubyDoc ] : http://www.rubydoc.info/gems/replace_gemname
133- [ Omniref ] : https://www.omniref.com/ruby/gems/replace_gemname
118+ [ RubyDoc ] : http://www.rubydoc.info/gems/makenew-ruby_gem
119+ [ Omniref ] : https://www.omniref.com/ruby/gems/makenew-ruby_gem
134120
135121## Development and Testing
136122
137123### Source Code
138124
139- The [ replace_gemname source] is hosted on GitHub.
125+ The [ makenew-ruby_gem source] is hosted on GitHub.
140126Clone the project with
141127
142128```
143- $ git clone https://github.com/replace_username/replace_gemname .git
129+ $ git clone https://github.com/makenew/ruby-gem .git
144130```
145131
146- [ replace_gemname source] : https://github.com/replace_username/replace_gemname
132+ [ makenew-ruby_gem source] : https://github.com/makenew/ruby-gem
147133
148134### Rake
149135
150136Run ` $ rake -T ` to see all Rake tasks.
151137
152138```
153- rake build # Build replace_gemname-0 .0.0.gem into the pkg directory
139+ rake build # Build makenew-ruby_gem-2 .0.0.gem into the pkg directory
154140rake bump:current[tag] # Show current gem version
155141rake bump:major[tag] # Bump major part of gem version
156142rake bump:minor[tag] # Bump minor part of gem version
@@ -159,9 +145,9 @@ rake bump:pre[tag] # Bump pre part of gem version
159145rake bump:set # Sets the version number using the VERSION environment variable
160146rake clean # Remove any temporary products
161147rake clobber # Remove any generated files
162- rake install # Build and install replace_gemname-0 .0.0.gem into system gems
163- rake install:local # Build and install replace_gemname-0 .0.0.gem into system gems without network access
164- rake release[remote] # Create tag v0 .0.0 and build and push replace_gemname-0 .0.0.gem to Rubygems
148+ rake install # Build and install makenew-ruby_gem-2 .0.0.gem into system gems
149+ rake install:local # Build and install makenew-ruby_gem-2 .0.0.gem into system gems without network access
150+ rake release[remote] # Create tag v2 .0.0 and build and push makenew-ruby_gem-2 .0.0.gem to Rubygems
165151rake rubocop # Run RuboCop
166152rake rubocop:auto_correct # Auto-correct RuboCop offenses
167153rake spec # Run RSpec code examples
@@ -190,6 +176,10 @@ To submit a patch:
190176
191177## License
192178
179+ This software can be used freely, see [ The Unlicense] .
180+ The copyright text appearing below and elsewhere in this repository
181+ is for demonstration purposes only and does not apply to this software.
182+
193183This Ruby gem is licensed under the MIT license.
194184
195185## Warranty
0 commit comments