Skip to content

Commit 56b75b8

Browse files
authored
Update readme with instructions (#108)
1 parent ce9e056 commit 56b75b8

File tree

1 file changed

+5
-14
lines changed

1 file changed

+5
-14
lines changed

Diff for: README.md

+5-14
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,16 @@ This website was built using [Jekyll](https://jekyllrb.com/). So if you are fami
1414

1515
**Setting up your development environment**
1616

17-
To do this, you are going to need a computer capable of running Ruby - while Mac OSX or Linux tends to be easiest, plenty of people do Ruby development on Windows as well. If you're not on Mac OSX, you will likely need to install Ruby yourself.
17+
You need to install [Docker](https://docker.com) and [docker-compose](https://docs.docker.com/compose) and have GNU Make available.
1818

19-
**Install Gems and Serving the Website**
19+
To run setup the environment run this in your terminal:
2020

21-
The required gems for this project are [Bundler](http://bundler.io/) and [Jekyll](https://jekyllrb.com/). Once you have Ruby installed, open your terminal, `cd` to the local repo directory, and run the following commands:
21+
```make shell```
2222

23-
```
24-
gem install jekyll
25-
gem install bundle
26-
```
23+
This will setup docker-compose and start a bash session with jekyll inside. When you're in the shell, run:
2724

28-
This will install Bundler and Jekyll. If you have any errors, check to be sure you have installed Ruby correctly.
25+
```jekyll serve --watch```
2926

30-
Next, install the projects dependencies and serve:
31-
32-
```
33-
bundle install
34-
bundle exec jekyll serve
35-
```
3627

3728
This should start serving the website on http://0.0.0.0:4000/ - simply make changes to the source code and can see your changes live at that URL!
3829

0 commit comments

Comments
 (0)