Skip to content

Prioritizes bundler build instructions in README #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2016
Merged

Prioritizes bundler build instructions in README #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,26 @@ This site uses a Jekyll, a Ruby framework. The required Jekyll version is 1.5.1.

There are two ways to run Jekyll to build the site:

* using globally installed Jekyll and accompanying gems
* using Bundler, so Jekyll and accompanying gems are installed only inside this directory
1. using Bundler, so Jekyll and accompanying gems are installed only inside this directory
2. using globally installed Jekyll and accompanying gems

The former method is the one currently actually used on
scala-lang.org. The latter method may be more convenient for users who
are comfortable using Bundler and who don't want anything else
installed system-wide.
The latter method is the one currently actually used on scala-lang.org. The
former method is likely most convenient for users who already have a different
version of Jekyll installed, or who are comfortable using Bundler and who don't
want anything else installed system-wide.

### Building with global Jekyll
### Option 1) Building with Bundler

`cd` into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`.

Start the server in the context of the bundle:

bundle exec jekyll serve

from this point, everything else should be the same, regardless of which method
you used to run Jekyll.

### Option 2) Building with global Jekyll

Install Jekyll 1.5.1 on your system using RubyGems:

Expand All @@ -39,17 +50,6 @@ and watch the output. You should see something like:
Generating... done.
Auto-regeneration: enabled for '/Users/ben/src/scala-lang'

### Building with Bundler

`cd` into the directory where you cloned this repository, then install the required gems with `bundle install`. This will automatically put the gems into `./bundle-vendor/bundle`.

Start the server in the context of the bundle:

bundle exec jekyll serve

from this point, everything else should be the same, regardless of which method
you used to run Jekyll.

### Windows and UTF-8

If you get `incompatible encoding` errors when generating the site under Windows, then ensure that the
Expand Down