initial commit

1 files changed, 33 insertions, 0 deletions

diff --git a/themes/cranky/README.md b/themes/cranky/README.md
new file mode 100644
index 0000000..58959fa
--- /dev/null
+++ b/themes/cranky/README.md
@@ -0,0 +1,33 @@
+# Cranky hugo theme (based on lukesmithxyz/lugo)
+
+A simple Hugo theme I plan on using for my personal website.
+I plan to do lot's of things:
+
+- Study
+- Work on home projects
+- Take photos
+- Blog
+
+I want a website that handles it all. Projects should be part of some
+portfolio I can showcase. Photos should have a dedicated photography
+section. My posts shouldn't get mixed with my portfolio.
+
+This theme aims to do these three things in one simple package.
+
+## get started
+
+```sh
+hugo new site new-site
+cd new-site
+git clone https://github.com/lukesmithxyz/lugo themes/lugo
+echo "theme = 'cranky'" >> config.toml
+cp themes/lugo/static/style.css static/
+```
+
+## stuff
+
+- Makes one RSS feed for the entire site at `/index.xml`
+- Stylesheet is in `/style.css` and includes some important stuff for partials.
+- If a post is tagged, links to the tags are placed at the bottom of the post.
+- `nextprev.html` adds links to the Next and Previous articles to the bottom of a page.
+- `taglist.html` links all tags an article is tagged to for related content.