Add README and LICENSE

This commit is contained in:
James Eversole 2024-02-18 18:38:51 -06:00
parent c63d28e779
commit 4bbc0a9827
2 changed files with 42 additions and 0 deletions

7
LICENSE Normal file
View File

@ -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.

35
README Normal file
View File

@ -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)