Skip to content

Commit e85cd18

Browse files
committed
Merge pull request scala#429 from scala/upd-readme
Prioritizes bundler build instructions in README
2 parents 838d0dd + 30fae2f commit e85cd18

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,26 @@ This site uses a Jekyll, a Ruby framework. The required Jekyll version is 1.5.1.
1212

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

15-
* using globally installed Jekyll and accompanying gems
16-
* using Bundler, so Jekyll and accompanying gems are installed only inside this directory
15+
1. using Bundler, so Jekyll and accompanying gems are installed only inside this directory
16+
2. using globally installed Jekyll and accompanying gems
1717

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

23-
### Building with global Jekyll
23+
### Option 1) Building with Bundler
24+
25+
`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`.
26+
27+
Start the server in the context of the bundle:
28+
29+
bundle exec jekyll serve
30+
31+
from this point, everything else should be the same, regardless of which method
32+
you used to run Jekyll.
33+
34+
### Option 2) Building with global Jekyll
2435

2536
Install Jekyll 1.5.1 on your system using RubyGems:
2637

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

42-
### Building with Bundler
43-
44-
`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`.
45-
46-
Start the server in the context of the bundle:
47-
48-
bundle exec jekyll serve
49-
50-
from this point, everything else should be the same, regardless of which method
51-
you used to run Jekyll.
52-
5353
### Windows and UTF-8
5454

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

0 commit comments

Comments
 (0)