From fb172f7e632b88af2423280cdf5ae01201ec2015 Mon Sep 17 00:00:00 2001 From: "Zed A. Shaw" Date: Wed, 30 Jul 2025 00:45:32 -0400 Subject: [PATCH] Update the README.md to show how to use it. --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4dd23ae..25129b3 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,15 @@ > __"This isn't even my final form."__ -SSG is a Static Site Generator that is only a Static Site Generator. No resumes here! Just a piece of code that generates static files from templates for websites, and can do it live while you develop said templates. +SSG is a Static Site Generator that is only a Static Site Generator. No resumes here! I'll never work at Amazon, Google, or Microsoft so SSG doesn't include every single thing they've ever made. Just a piece of code that generates static files from templates for websites, and can do it live while you develop said templates. -## Notes -* Prior art https://github.com/darccio/zas -* Obviously Hugo too - -## Key Features Needed +## Planned Features Needed * Simply converts dir to other dir. * Whatever templates I'm using, and markdown. * Watches the dir and reruns the build when there's a change. -* Simple built-in webserver to host the changes. +* Simple built-in webserver to view the changes. * Possibly template lint or html lint. * https://github.com/sourcegraph/go-template-lint * https://www.djlint.com/docs/languages/golang/ @@ -24,15 +20,10 @@ SSG is a Static Site Generator that is only a Static Site Generator. No resumes ## Usage -```bash -# init your config -$ ssgod init +Look in examples/ssgod.toml for a sample. Copy that to your directory then just do this: -# creates a ssgod.tomly +```bash $ ssgod - -# explicit ssgod -$ ssgod --config ssgod.toml ``` -* Probably just an extension mapping: .md -> .html, .html -> .html +In the future there will be a command to init a config and to setup directories that you need for your config to run.