From 6e7db02fc8f8939d0b972b07d77098ab1eace0da Mon Sep 17 00:00:00 2001 From: Andrew Quinn <53230903+AndrewQuinn2020@users.noreply.github.com> Date: Sun, 21 Nov 2021 12:14:22 +0200 Subject: [PATCH] Added a quickstart section. Added a quickstart section for people new to Hugo to quickly get to using this theme. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index ebbd5cf..6b297ae 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,30 @@ By utilizing copious partial templates the theme is largely customizable. This is a fork of the original [hugo-tufte](https://github.com/shawnohare/hugo-tufte). +## Quickstart + +### Prerequisite: Hugo Extended + +You'll need to install Hugo Extended for this theme to test it locally, since this theme uses SCSS. +- On Windows: + - Using [Chocolatey](https://chocolatey.org/): + ```powershell + choco install hugo-extended # remember, you might need admin privs + ``` + +### For a new site + +```powershell +# this code is shell-agnostic, and should work in cmd, powershell, bash, zsh.... +hugo new site # create your new site with hugo in your pwd +cd \themes\ # cd into the themes directory +git clone # HTTPS link @ the top of the page if you've never done this before +``` + +Add `theme = 'hugo-tufte'` to your `config.toml` to let your site know to actually use _this_ theme, specifically. + +Then run `hugo server -D` and open up `localhost:1313/` or wherever it says in Firefox. + ## Features ### Math