Skip to content

Commit 5cbdc57

Browse files
committed
update readme
1 parent f764bc5 commit 5cbdc57

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Contributions are welcome. Feel free to open a pull request with changes.
1010

11-
### Running it Locally
11+
## Running it Locally
1212

1313
It can be helpful to preview changes on your computer before opening a pull request. *ROOCS website* uses the [Jekyll static site generator](http://jekyllrb.com/). After forking or cloning the repository, perform the following steps to generate the site and preview it:
1414

@@ -17,9 +17,28 @@ It can be helpful to preview changes on your computer before opening a pull requ
1717
- `bundle exec jekyll serve`
1818
- Point your browser at http://127.0.0.1:4000/
1919

20+
### Use Docker as build environment
21+
22+
Run this once to generate Gemfile.lock:
23+
```
24+
docker-compose run jekyll bundle install
25+
```
26+
27+
Build image:
28+
```
29+
docker-compose build
30+
```
31+
32+
Start service:
33+
```
34+
docker-compose up
35+
```
36+
37+
Open http://localhost:4000
38+
2039
## Deployment
2140

22-
Pull requests merged to the master branch are automatically deployed to the production website.
41+
Pull requests merged to the main branch are automatically deployed to the production website.
2342

2443
## License
2544

0 commit comments

Comments
 (0)