hugo-starter-readable

commit 10e2b1acdd2376b6732b80db7f4ac3e781a96363
parent 3978680197ac515ed181dacb3a032552afeffb48
Author: CJ <cjtheham@protonmail.com>
Date:   Sun, 11 Jun 2023 20:41:57 -0500

quick docs update

Diffstat:
M
README.md
 | 
14
++++++++++++--

1 file changed, 12 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
 # Hugo Readable Template
 
-To use this template, simply clone this site, update the config files, and follow the Hugo documentation for making new posts and deploying!
-\ No newline at end of file
+To use this template, simply clone this site, update the config files, and follow the Hugo documentation for making new posts and deploying!
+
+# Steps to Deploy
+
+1. Duplicate the repo. Few options here: use Github's "use template" button, download zip file and use that, or just fork the repo.
+2. Make sure you have Hugo installed.
+3. Run `git submodule update --init` to download the theme.
+4. Update `config/_default/config.yml` and `params.yml` to your blogs info.
+5. Put whatever you want in index.html.
+6. Write your first blog post, and delete the default ones in `/content/posts/*`.
+7. Deploy your site to the static host of your choice.
+\ No newline at end of file