From 4bbc0a98271657c7416753e209e11bf36f9df423 Mon Sep 17 00:00:00 2001 From: James Eversole Date: Sun, 18 Feb 2024 18:38:51 -0600 Subject: [PATCH] Add README and LICENSE --- LICENSE | 7 +++++++ README | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 LICENSE create mode 100644 README diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..6a7b34a --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +ISC LICENSE + +Copyright James Eversole (james@eversole.co) + +Permission to use, copy, modify, and/or 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 new file mode 100644 index 0000000..da129a7 --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +# the sampu Haskell blog engine + +https://blog.eversole.co (not live yet!) + +a _work-in-progress_ blog engine using simple flat-file Markdown content storage. + +sampu is a word in Lojban meaning: +"x1 is __simple__/__unmixed__/__uncomplicated__ in property x2" + +Therefore, `la sampu cu sampu .ui` ! + +## Stack + +- ["Haskell"](https://www.haskell.org) +- ["Twain"](https://github.com/alexmingoia/twain) +- ["Lucid2"](https://chrisdone.com/posts/lucid2) +- ["HTMX"](https://htmx.org/) + +## Goal + +Provide a simple blog engine that is easily customizable via HTML fragments +and easy HTMX integration for dynamic content. + +## Deployment + +We're not there yet, but soon! This project is built and packaged with Nix, +so I will provide directions on deploying with Nix as well as via OCI +containers once there's something viable to run here. + +## Development and Support + +Per the permissive ISC license, you are free to do what you wish with this +software. No guarantees are made to its usability, security, or functionality. + +Copyright James Eversole (james@eversole.co)