From 3176983493621299b10dae5b618fde1ea158fa4c Mon Sep 17 00:00:00 2001 From: Katy Huff Date: Thu, 30 Jan 2025 17:14:23 -0600 Subject: [PATCH 1/4] adds instructions so folks can build the website --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7fe98c65..e5cff72e 100644 --- a/README.md +++ b/README.md @@ -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 git@github.com: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. From 26bff3f59cdaaba775b3c619c074e90ff9ac11b4 Mon Sep 17 00:00:00 2001 From: Katy Huff Date: Thu, 30 Jan 2025 17:17:29 -0600 Subject: [PATCH 2/4] double to single quotes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e5cff72e..7192028a 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Fuel Cycles group. It should be sufficient to do the following: Clone the repo: -`git clone git@github.com:arfc/arfc.github.io" +`git clone git@github.com:arfc/arfc.github.io` Make your way to the top level of the source branch `cd arfc.github.io && git checkout source` From fd388df706bb10d1245ff55cfa683468539d66f9 Mon Sep 17 00:00:00 2001 From: Katy Huff Date: Mon, 3 Feb 2025 09:34:22 -0600 Subject: [PATCH 3/4] Update README.md Co-authored-by: Nathan Ryan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7192028a..a7535e2e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ It should be sufficient to do the following: Clone the repo: `git clone git@github.com:arfc/arfc.github.io` -Make your way to the top level of the source branch +Make your way to the top level of the source branch: `cd arfc.github.io && git checkout source` Install the gems: From d9a052b587e48c0de2f966780c348eedf0287735 Mon Sep 17 00:00:00 2001 From: Katy Huff Date: Mon, 3 Feb 2025 09:34:32 -0600 Subject: [PATCH 4/4] Update README.md Co-authored-by: Nathan Ryan --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a7535e2e..a498c1e8 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Make your way to the top level of the source branch: Install the gems: `bundle install` -Build and serve the site locally +Build and serve the site locally: `bundle exec jekyll serve` The terminal will report that your website is being served at localhost:4000.