From 18780e4810008b3ba764e945d1362b8dfb8b29b2 Mon Sep 17 00:00:00 2001 From: Brandon Rozek <30753990+Brandon-Rozek@users.noreply.github.com> Date: Wed, 15 Jan 2020 22:15:23 -0500 Subject: [PATCH] Create README.md --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5e666d --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# BrandonRozek.com +Github Repo of Personal Website + +## Instructions + +In order to build the site you need to have `hugo` and `git` installed. + +Clone the repository +```bash +git clone --recurse-submodules https://github.com/Brandon-Rozek/website +``` +If you don't include `--recurse-submodules` then the theme won't load rendering the site unusable. + +Then you need to build the site +```bash +cd website +hugo +``` +All of the HTML files generated will appear in the folder `Public`. You can then copy this folder over to a webserver. + +If you want to run the website locally, then run +```bash +hugo serve +``` +This will start a webserver that hosts the site using a port (usually 1313) on your localhost.