mirror of
https://github.com/Brandon-Rozek/website.git
synced 2024-09-07 17:42:29 -04:00
Create README.md
This commit is contained in:
parent
ea6919bf2d
commit
18780e4810
1 changed files with 25 additions and 0 deletions
25
README.md
Normal file
25
README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue