From 5e6112fb18d356227336caa5882ea769325530a3 Mon Sep 17 00:00:00 2001
From: Bill Niblock <bill@theinternetvagabond.com>
Date: Fri, 14 Jun 2024 16:46:06 -0400
Subject: [PATCH] Add README, try to make workflow work

---
 .forgejo/workflows/publish.yaml | 20 ++++++++++-------
 README.md                       | 38 +++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+), 8 deletions(-)
 create mode 100644 README.md

diff --git a/.forgejo/workflows/publish.yaml b/.forgejo/workflows/publish.yaml
index 41ced17..0b1c449 100644
--- a/.forgejo/workflows/publish.yaml
+++ b/.forgejo/workflows/publish.yaml
@@ -11,20 +11,24 @@ jobs:
         uses: actions/checkout@v4
         with:
           ref: pages
-          path: '_site'
+          path: _site
       - name: Setup cache directory
         run:  mkdir .jekyll-cache
       - name: Install dependencies
         run: bundle install
       - name: Build the site
         run: jekyll build --trace
-      - name: Publish
+      - name: Check source status
+        run: |
+          git status
+      - name: Check site status
         run: |
           cd _site
-          touch .nojekyll
-          git config user.name "Scribe"
-          git config user.email "scribe@niblock.tech"
-          git add -A
           git status
-          git commit -m "Automated Publish"
-          git push
+          # touch .nojekyll
+          # git config user.name "Scribe [bot]"
+          # git config user.email "scribe@niblock.tech"
+          # git add -A
+          # git status
+          # git commit -m "Automated Publish"
+          # git push
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c162de9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+# TTRPG Compendium
+
+Static, Jekyll-based site for all tabletop RPG-related stuff I write about.
+
+### Adventures
+
+Some of the adventures I've written up or am working on.
+
+### Journals
+
+Both character and campaign journals
+
+### Tools
+
+Stuff that helps with TTRPG play.
+
+## Building
+
+For just running locally, easiest is to use a container:
+
+```
+    docker run --rm \
+               --volume="$PWD:/srv/jekyll:Z" \
+               --publish [::1]:4000:4000 \
+               jvconseil/jekyll-docker \
+               jekyll serve
+```
+
+For modifying and publishing newly generated content, the following process
+works pretty well:
+
+1. Remove the `_site` directory.
+2. Clone the "pages" branch into `_site`:
+   `git clone -b pages ssh://git@forge.niblock.tech:8222/vagabond/ttrpg-compendium.git _site`
+3. Run the container from above step. It will now build into `_site`, which is
+   linked to the "pages" branch.
+4. When satisfied with changes, be sure to push both from `_site` and the base
+   repository to keep the source and the results up-to-date.