Update README with simpler installation procedure #2783
Conversation
mjgiarlo
force-pushed
the
mjgiarlo-patch-1
branch
from
41cebba to
4786c7b
Compare
|
assigning myself while we get @cgalarza set up as a contributor |
| gem 'sufia', '7.2.0' | ||
| # If you don't already have Rails at your disposal... | ||
| gem install rails -v 5.0.0.1 | ||
| rails new my_app -m https://raw.githubusercontent.com/projecthydra/sufia/master/template.rb |
There was a problem hiding this comment.
Is there anyway to tie this url to the particular commit of this README? If users wanted to install a version of sufia that wasn't the version in master they would run into some trouble.
There was a problem hiding this comment.
that's a good question. I don't know if there's a latest release tag shortcut, which would be ideal.
There was a problem hiding this comment.
you can link to the latest release and be redirected to a tag, but I don't see a way for us to link to the tag as a tree.
There was a problem hiding this comment.
@barmintor @cgalarza I dig the idea, but I can't think of a good way to handle this. If I point at, say, the 7.2.0 release, the README will be broken because template.rb does not exist in the 7.2.0 release. I'm not sure I want to cut a special release just to fix up the README, though I can be convinced otherwise. Pointing at a release branch could work, but we tend to create those at point of need (when someone wants something backported). 🤔
What if we leave it pointing at master now, and use our release management process to edit this line when we cut our next release? I have already edited the release mgmt notes to reflect that cutting a new release should at least require reviewing, if not modifying, the README and template.rb.
There was a problem hiding this comment.
Wrote this up as an issue: #2784
There was a problem hiding this comment.
@mjgiarlo Editing the template url when a new release is cut sounds good to me.
There was a problem hiding this comment.
@cgalarza Thanks! I set it as a blocker for 7.3.0.
Goes with #2782