autonomic-cooperative/sophie-lewis-hugo
Archived
0
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Added new information to the readme.

Browse Source
This commit is contained in:
EJ Mitchell 2022-03-23 09:32:29 -04:00
parent a7091a0838
commit df670dfc3c
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,4 +1,25 @@
## Setup
This project uses `hugo` and git submodules. Below is how to set up Hugo on a
Linux machine.
1. Download `hugo` - you will need the `extended` version of Hugo. As of this
writing there does not seem to be an extended version available via `apt`.
However, you can use `snap` to get this version:
`snap install hugo --channel=extended`
2. Run the following to make sure the git submodules are installed:
```
git submodule init
git submodule update
```
3. Now you should be able to build the project. Run `hugo server` and go to the
localhost address printed in your terminal. 🐙
## How to change about me headshot
Add the headshot image you want to use to the `static/img` directory. Then uncomment the `headshot=` option under `[param.about]`. Set this option to the filename and only the filename.