Reorder readme steps reflecting that yard is required to bundle gems #58

Merged
merged 1 commit into from Dec 6, 2012

Conversation

Projects
None yet
2 participants
Contributor

cgunther commented Dec 6, 2012

The steps in the readme to get it running locally were outdated and didn't reflect that the Gemfile points to a local copy of yard, so yard must be cloned prior to running bundle install.

Yard's been referenced locally for about a year now (see 2d8f6f2) so figured I'd update the steps to be accurate since it tripped me up for a second.

Collaborator

lsegal commented Dec 6, 2012

Thanks. Ideally we want to use a gem install, but we maintain a separate install for yard as we occasionally run yard off of pre-releases. Unfortunately you can't list multiple sources for a dependency in a Gemfile.

@lsegal lsegal added a commit that referenced this pull request Dec 6, 2012

@lsegal lsegal Merge pull request #58 from cgunther/reorder-local-steps
Reorder readme steps reflecting that yard is required to bundle gems
fd683ec

@lsegal lsegal merged commit fd683ec into docmeta:master Dec 6, 2012

Contributor

cgunther commented Dec 6, 2012

What about pointing to the repo on GitHub via bundler, as opposed to a local install? http://gembundler.com/git.html

Only benefit there being that those who are not contributing to Yard as well don't have to worry about cloning it to the right path, bundler would just take care of fetching the prerelease.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment