From df670dfc3c4ad8004a150046958d8be511b48982 Mon Sep 17 00:00:00 2001 From: EJ Mitchell Date: Wed, 23 Mar 2022 09:32:29 -0400 Subject: [PATCH] Added new information to the readme. --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 66404e3..871d1e9 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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. +