Skip to content

Commit 39a5c8d

Browse files
committed
Update local dev docs
1 parent 3114afe commit 39a5c8d

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
## Local development
44

5-
The website is using [Jekyll](https://jekyllrb.com/) static website generator and [Github pages](https://pages.github.com/).
6-
To run and develop it locally you would need [Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/).
7-
With Ruby, you can install bundler using `gem install bundler`.
8-
Then install [`pre-commit`](https://repology.org/project/python:pre-commit/versions) to keep your commits clean.
5+
First install [`pre-commit`](https://repology.org/project/python:pre-commit/versions) to keep your commits clean.
96

10-
After that all you need is:
7+
The website is using [Jekyll](https://jekyllrb.com/) static website generator and [Github pages](https://pages.github.com/).
8+
To run and develop it locally you need to install [`rbenv`](rbenv.org) using `apt install rbenv ruby-build`.
9+
Then use `rbenv init` and follow the instructions to set it up.
10+
With `rbenv` installed and activated in your shell:
1111

1212
```bash
13-
git clone https://github.com/precice/precice.github.io && cd precice.github.io
13+
git clone --recurse-submodules https://github.com/precice/precice.github.io && cd precice.github.io
1414
pre-commit install
15+
rbenv install
1516
bundle install
16-
git submodule init
17-
git submodule update
1817
bundle exec jekyll serve -l
1918
```
2019

@@ -33,6 +32,14 @@ Afterwards, commit and push.
3332

3433
Do not directly edit the content of the submodules from within the website repository. This might give ugly merge conflicts.
3534

35+
## Pull with submodules
36+
37+
To pull changes including submodules
38+
39+
```bash
40+
git pull --recurse-submodules
41+
```
42+
3643
## Build inside a Docker container
3744

3845
Instead of building on your system (which requires some setup the first time), you can directly serve the website from a Docker container (using the community image [`jekyll/jekyll`](https://hub.docker.com/r/jekyll/jekyll)). In this directory, after you initialize and update the git submodules, run the following:

0 commit comments

Comments
 (0)