Installation and getting started instructions don't work

[RepublicOfAppsLLC]

Hi,

Awesome, gem, thanks so much for this.

There are a couple of issues with your instructions in the repo's readme.

shell> gem install jeweler
... succeeds ...

shell> jeweler hello-gem
    create  .gitignore
    create  Rakefile
    create  Gemfile
    create  LICENSE.txt
    create  README.rdoc
    create  .document
    create  lib
    create  lib/hello-gem.rb
    create  test
    create  test/helper.rb
    create  test/test_hello-gem.rb

shell> rake -T
Could not find gem 'shoulda (>= 0) ruby' in the gems available on this machine.
Run `bundle install` to install missing gems

shell> bundle
Fetching gem metadata from http://rubygems.org/..........
Fetching gem metadata from http://rubygems.org/..
Resolving dependencies...
Using atomic (1.1.16)
Using bundler (1.4.0.rc.1)
Using i18n (0.6.9)
Using multipart-post (2.0.0)
Using git (1.2.6)
Using hashie (2.0.5)
Using mini_portile (0.5.3)
Installing multi_xml (0.5.5)
Installing docile (1.1.3)
Installing builder (3.2.2)
Installing multi_json (1.9.2)
Using highline (1.6.21)
Using json (1.8.1)
Using thread_safe (0.3.1)
Installing minitest (4.7.5)
Using faraday (0.9.0)
Using jwt (0.1.11)
Installing addressable (2.3.6)
Using descendants_tracker (0.0.4)
Using rdoc (3.12.2)
Installing rake (10.2.2)
Installing shoulda-context (1.2.1)
Installing rack (1.5.2)
Using oauth2 (0.9.3)
Installing tzinfo (0.3.39)
Using nokogiri (1.6.1)
Using github_api (0.11.3)
Using jeweler (2.0.1)
Installing simplecov-html (0.8.0)
Installing simplecov (0.8.2)
Installing activesupport (4.0.4)
Installing shoulda-matchers (2.5.0)
Installing shoulda (3.5.0)
Your bundle is complete!
Use `bundle show [gemname]` to see where a bundled gem is installed.

shell> rake install
rake aborted!
Gem::InvalidSpecificationException: "FIXME" or "TODO" is not a description

Tasks: TOP => install => build
(See full trace by running task with --trace)

So what's missing is:

• You need to bundle inside the gem's dir first to ensure dependencies are installed, else rake won't work
• rake install fails

I figured these out, but it's confusing for a new user to see the instructions lead to errors on the first run ...

Am I missing something? Should I update the readme?

Thanks

[technicalpickles]

For the bundle install, I think that's something jeweler can be doing for sure.

For rake install failing, check rake install --trace. It's likely complaining because rubygems doesn't allow FIXME or TODO in the description or summary anymore. Those would be defined in your Rakefile.

Definitely worth improving docs and/or the code to handle those better.