From f315d4598b6ea9db87d18fbc470391be75e879cc Mon Sep 17 00:00:00 2001
From: David Thurstenson <thurstylark@gmail.com>
Date: Sun, 21 Nov 2021 16:47:03 -0600
Subject: [PATCH] Added README

---
 .gitignore |  3 ++
 README.md  | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index c77539a..d7da70a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,3 +18,6 @@
 
 # Static directory
 !static/
+
+# README
+!README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..86c41c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,85 @@
+# Thurstylark's wiki
+
+
+
+## Requirements
+
+- Base
+  - hugo
+- Optional (required for `tlwiki` management script)
+  - git
+  - python3
+  - rsync
+
+
+## Usage
+
+
+### Environment Setup
+
+
+#### Using `tlwiki` script
+
+1. Ensure these additional requirements are met:
+2. Create `tlwiki-conf.yaml` using `tlwiki-conf.yaml.ex` as a template
+3. Run `./tlwiki updeps` to pull in the latest version of all git submodules
+
+
+#### Using individual commands
+
+1. Initialize all git submodules 
+```
+git submodule update --init --recursive
+```
+
+
+### Deploy
+
+
+#### Using `tlwiki` script
+
+1. Ensure the values for `deployID.user`, `deployID.host`, and `deployID.dir` are correct
+  - For best results, use rsync with a non-interactive authentication method such as ssh key pairs
+2. Run `./tlwiki deploy`
+
+
+#### Using individual commands
+
+1. Run `hugo` to build the site
+2. Copy the contents of `public/` to your web server's document root
+
+
+
+## Hacking
+
+
+### Automatically run `./tlwiki deploy` on `git push`
+
+Create a symlink named `.git/hooks/pre-push` with `tlwiki` as its target:
+```
+ln -s .git/hooks/pre-push ../../tlwiki
+```
+
+`tlwiki` will help manage this symlink in the future (See: [#1](https://git.thurstylark.com/thurstylark/tlwiki/issues/1))
+
+
+### Serve the site locally for testing
+
+```
+hugo server
+```
+
+More info: https://gohugo.io/commands/hugo_server/
+
+
+
+## `tlwiki-config.yaml` Configuration Options
+
+| Path            | Type   | Default | Description                                              |
+|-----------------|--------|---------|----------------------------------------------------------|
+| deployID.user   | string | <none>  | rsync username (`USER` in `USER@HOST:DIR`)               |
+| deployID.host   | string | <none>  | rsync hostname (`HOST` in `USER@HOST:DIR`)               |
+| deployID.dir    | string | <none>  | rsync target remote directory (`DIR` in `USER@HOST:DIR`) |
+| repo.URL        | string | <none>  | Unused                                                   |
+| repo.branch     | string | <none>  | Unused                                                   |
+| repo.remoteName | string | <none>  | Unused                                                   |