diff --git a/LICENSE b/LICENSE index 2071b23..913f2fa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) +Copyright (c) Zed A. Shaw Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/README.md b/README.md index 9746b01..4600433 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,33 @@ -# super-saiyan-god +# Super Saiyan God -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. \ No newline at end of file +> __"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. + +## Notes + +* Prior art https://github.com/darccio/zas +* Obviously Hugo too + +## Key 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. +* Possibly template lint or html lint. + * https://github.com/sourcegraph/go-template-lint + * https://www.djlint.com/docs/languages/golang/ +* Code highlighting -- should that prism or something else? + +## Usage + +```bash +# assumes a ssgod.tomly +$ beerus + +# explicit ssgod +$ beerus --config ssgod.toml +``` + +* Probably just an extension mapping: .md -> .html, .html -> .html diff --git a/art/beerus_ssg_logo_parody.png b/art/beerus_ssg_logo_parody.png new file mode 100644 index 0000000..02fbe44 Binary files /dev/null and b/art/beerus_ssg_logo_parody.png differ