aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhistoria <historiavg@proton.me>2026-07-30 16:41:42 -0400
committerhistoria <historiavg@proton.me>2026-07-30 16:41:42 -0400
commit317033703195fb1c5695e36e5899fe0080fc441e (patch)
treefafe516a9e2a8e9324337fd6090f38c1865befc3
parent990f92017d4cabf8e28df0f615db8dac449edded (diff)
downloadssg-blog-main.tar.gz
move to historia.vgHEADmain
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index e3fcbf0..03ab255 100644
--- a/README.md
+++ b/README.md
@@ -8,12 +8,14 @@ It also generates a sitemap.xml and rss.xml file.
# Install / Usage
-See [https://romansolotarev.com/ssg.html](https://romanzolotarev.com/ssg.html) for documentation on ssg
+See [https://romansolotarev.com/ssg.html](https://romanzolotarev.com/ssg.html) for documentation on ssg. Install [lowdown](https://kristaps.bsd.lv/lowdown/) and cpio.
-1. Install [lowdown](https://kristaps.bsd.lv/lowdown/) and cpio
-2. Copy the `ssg-blog` script somewhere in your path, e.g. `/usr/bin/`
-3. `chmod +x /usr/bin/ssg-blog`
-4. `ssg-blog src dst 'https://my-website.net'`
+```
+git clone https://git.historia.vg/git/ssg-blog
+cp ssg-blog/ssg-blog /usr/bin/ # (or somewhere in your path)
+chmod +x /usr/bin/ssg-blog
+ssg-blog src dst 'https://my-website.net'
+```
ssg-blog checks for subdirectories in the src directory, each of which becomes a category heading (non-recursively). It will generate a sorted list of links to any .md file in those directory (including nested directories).