Skip to content

Commit 200b15c

Browse files
mkasberggeerlingguy
authored andcommitted
Improve the README
The README needed a little love. Primarily, I wanted to avoid recommending `sudo gem install` as that's widely considered not to be a best practice. Using a version of Ruby installed with rbenv is a better way to avoid permission errors. * Recommend using rbenv to install a modern version of Ruby. * Avoid recommending `sudo` to install gems. * `bundle install --path ...` is deprecated, and isn't really necessary anyway. A simple `bundle install` is fine. * Clarify update instructions.
1 parent e034c03 commit 200b15c

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Open Source Catholic
22

3-
This Jekyll project powers https://www.opensourcecatholic.com/
3+
This Jekyll project powers <https://www.opensourcecatholic.com/>.
44

55
Open Source Catholic's mission is to help Catholic developers and organizations involved in software and web development find effective solutions for spreading the Gospel of Jesus Christ.
66

@@ -14,11 +14,15 @@ You can contribute content to Open Source Catholic following the guide in CONTRI
1414

1515
## Local Development
1616

17+
Building the site locally requires Ruby. We recommend installing Ruby using [rbenv](https://github.com/rbenv/rbenv). You should install and use a version of ruby matching the one specified in [.ruby-version](.ruby-version).
18+
1719
To get started building the site locally, run the following commands in the project directory:
1820

19-
1. `gem install jekyll bundler` (use `sudo` if you get a permission error)
20-
2. `bundle install --path vendor/bundle`
21+
1. `gem install jekyll bundler`
22+
2. `bundle install`
2123
3. `bundle exec jekyll serve`
22-
4. Browse to [http://localhost:4000/](http://localhost:4000/)
24+
4. Open [http://localhost:4000/](http://localhost:4000/) in a web browser
25+
26+
### Updating Gems
2327

24-
To update the gems in `Gemfile.lock` (if they are out of date), run `bundle update`.
28+
To update the gems in `Gemfile.lock` (if they are out of date), run `bundle update` and commit the new `Gemfile.lock`.

0 commit comments

Comments
 (0)