Skip to content

Commit a0aac3e

Browse files
committed
Merge #547: Readme: fix and extend instructions to install Ruby
94f550f Readme: fix and extend instructions to install Ruby (David A. Harding) Pull request description: Closes #534 - Fixes Ruby version error (previous instructions say "or greater" but an exact version match is required). - Clarifies that `bundle` needs to be run in the source directory - Updates the `htmlproof` command to match the syntax currently used in `.travis.cfg` ; this is necessary because the old syntax will fail on links to the `bin/` directory since that's not part of the repository. Tree-SHA512: bebaf526703dcf5fd4d66507acba66876085a78b7398008e331960551ce888ce65d4e95e0b5d0a3ee2aeb48de317c8b13b0c92f7143730b01b28d539166d6f3d
2 parents 6e19172 + 94f550f commit a0aac3e

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,20 @@ permalink: /en/2016/01/01/short-title
4747

4848
## Building
4949

50-
This website is based on Jekyll. To build locally, [install Ruby 2.2.2](https://gorails.com/setup) or greater
51-
and then run the following commands:
50+
This website is based on [Jekyll](https://jekyllrb.com/). To build
51+
locally, [install Ruby 2.2.2](https://gorails.com/setup) using system
52+
packages, [rvm](https://rvm.io), or another method. Then clone this
53+
repository and change directory into it:
54+
55+
git clone https://github.com/bitcoin-core/bitcoincore.org.git
56+
cd bitcoincore.org
57+
58+
Install the `bundle` utility using the Ruby package manager, `gem`, and
59+
then use `bundle` to install the rest of the Ruby packages needed to
60+
build this site. Note, depending on your system configuration, you may
61+
need to run `gem` as the superuser by putting "sudo" followed by a space
62+
before the `gem` command. You shouldn't need to use `sudo` with the
63+
`bundle` command.
5264

5365
gem install bundle
5466
bundle install
@@ -66,7 +78,8 @@ pages dated in the future (such as prepared release announcements).
6678

6779
To test the site:
6880

69-
bundle exec jekyll build --future --drafts --unpublished && bundle exec htmlproof ./_site
81+
bundle exec jekyll build --future --drafts --unpublished
82+
bundle exec htmlproof --disable-external --url-ignore '/^\/bin/.*/' ./_site
7083

7184
The additional parameters to `jekyll build` ensure that all possible
7285
pages are built and checked.

0 commit comments

Comments
 (0)