Skip to content

Commit

Permalink
Merge pull request #363 from katyhuff/readme-install
Browse files Browse the repository at this point in the history
adds instructions so folks can build the website
  • Loading branch information
katyhuff authored Feb 3, 2025
2 parents d480758 + d9a052b commit 430866f
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,26 @@ Fuel Cycles group.

## Building This Website

Coming soon...
It should be sufficient to do the following:

Clone the repo:
`git clone [email protected]:arfc/arfc.github.io`

Make your way to the top level of the source branch:
`cd arfc.github.io && git checkout source`

Install the gems:
`bundle install`

Build and serve the site locally:
`bundle exec jekyll serve`

The terminal will report that your website is being served at localhost:4000.
Navigate your browser there and you should see the webpage.

## Advanced build and push
Do everything in the previous section. If everything looks ok on preview,
execute:
`rake publish`

The built site will be committed to master and force pushed up to the website.

0 comments on commit 430866f

Please sign in to comment.