commit 14db6bf91c62b977b73a8386f8cbd75020fb0fcf
parent 800d91b3eddf3e40645db1f9407e008000d47e00
Author: Paco Esteban <paco@e1e0.net>
Date: Wed, 1 Jul 2020 20:07:15 +0200
add README and LICENSE
Diffstat:
| A | LICENSE | | | 13 | +++++++++++++ |
| A | README | | | 26 | ++++++++++++++++++++++++++ |
2 files changed, 39 insertions(+), 0 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright (c) 2020 Paco Esteban <paco@e1e0.net>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/README b/README
@@ -0,0 +1,26 @@
+What is this ?
+"ssnail" is a crappy and opinionated static website generator.
+
+What ? ssnail ?
+Well, naming is hard. I thought it would be slow for some stupid reason
+(spoiler, is not). So I used a name generator, started smashing the
+"generate" button until "Silver Snail" came out and I thought "meh, good
+enough".
+
+Ok, and how is it like ?
+It's written in C just for the fun of it (yes, the fun, what !?). Also,
+it's far from finished, but it's enough for me. It converts every
+Markdown file to HTML, copies everything else recursively and generates
+an index and RSS if needed.
+It's pretty fast despite my best efforts, 150ms for my small site.
+
+What about the code ?
+Distributed under the ISC license. See LICENSE or the header of each
+file. Oh! one more thing, if you look at the code, you have to know
+that what has been seen cannot be unseen ... You have been warned.
+You probably don't want to use this. It's pretty focused on my needs.
+
+Read the man page for more information.
+
+Thanks to tracey@ for the help and ideas (and for not running away in
+fear when I sent him the code).
