-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #363 from katyhuff/readme-install
adds instructions so folks can build the website
- Loading branch information
Showing
1 changed file
with
23 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |