brozek/website
1
0
Fork 0
mirror of https://github.com/Brandon-Rozek/website.git synced 2024-11-21 15:56:29 -05:00
Code Issues Projects Releases Packages Wiki Activity

Create README.md

Browse source
This commit is contained in:
Brandon Rozek 2020-01-15 22:15:23 -05:00 committed by GitHub
parent ea6919bf2d
commit 18780e4810
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md Normal file
View 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.