Skip to content

Commit 430866f

Browse files
authored
Merge pull request #363 from katyhuff/readme-install
adds instructions so folks can build the website
2 parents d480758 + d9a052b commit 430866f

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,26 @@ Fuel Cycles group.
66

77
## Building This Website
88

9-
Coming soon...
9+
It should be sufficient to do the following:
10+
11+
Clone the repo:
12+
`git clone git@github.com:arfc/arfc.github.io`
13+
14+
Make your way to the top level of the source branch:
15+
`cd arfc.github.io && git checkout source`
16+
17+
Install the gems:
18+
`bundle install`
19+
20+
Build and serve the site locally:
21+
`bundle exec jekyll serve`
22+
23+
The terminal will report that your website is being served at localhost:4000.
24+
Navigate your browser there and you should see the webpage.
25+
26+
## Advanced build and push
27+
Do everything in the previous section. If everything looks ok on preview,
28+
execute:
29+
`rake publish`
30+
31+
The built site will be committed to master and force pushed up to the website.

0 commit comments

Comments
 (0)