templates/ruby/README.md in noe-1.5.0 vs templates/ruby/README.md in noe-1.5.1
- old
+ new
@@ -1,10 +1,10 @@
# Noe template for ruby projects
-This project provides a [Noe](https://github.com/blambeau/noe) template for creating a
-ruby gem library. Generated project comes with rake tasks to support the lifecycle of
-the library (testing, releasing, and so on). Following Noe's philosophy this template
+This project provides a [Noe](https://github.com/blambeau/noe) template for creating a
+ruby gem library. Generated project comes with rake tasks to support the lifecycle of
+the library (testing, releasing, and so on). Following Noe's philosophy this template
also helps you understanding the ruby ecosystem by providing a fully documented project,
rake tasks, and so on.
## Install
@@ -20,39 +20,39 @@
### Creating a ruby project
# Prepare generation
noe prepare --template=ruby foo
cd foo
-
+
# Edit specific information about your project
edit foo.noespec
-
+
# Let Noe generate your project
noe go
-
- # Install your ruby dependencies then run rake
+
+ # Install your ruby dependencies then run rake
bundle install
rake
-
+
## Rake tasks installed by this template
-The following rake tasks are provided to your Rakefile by this template. Have a look at the
-_tasks_ folder for specific configuration additional information.
+The following rake tasks are provided to your Rakefile by this template. Have a look at the
+_tasks_ folder for specific configuration additional information.
# Running tests
rake spec_test # Run RSpec code examples
rake unit_test # Run unit tests
rake test # spec_test & unit_test
-
+
# Generating documentation
rake yard # Generate YARD Documentation
-
+
# Releasing and packaging
rake gem # Build the gem file
rake package # Build all the packages
rake repackage # Force a rebuild of the package files
rake clobber_package # Remove package products
-
+
## External dependencies
* This template requires [bundler, >= 1.0](http://gembundler.com/)
* The _spec_ tasks requires [rspec, >= v2.4.0](http://relishapp.com/rspec)
* The _yard_ tasks requires [yard, >= v0.6.4](http://yardoc.org/) which itself relies on
\ No newline at end of file