Clarify README

This commit is contained in:
2024-02-18 20:05:18 -06:00
parent 4bbc0a9827
commit 9255c8e4ac

35
README.md 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](https://mw.lojban.org) with the English definition:
"x1 is __simple__/__unmixed__/__uncomplicated__ in property x2"
Therefore, `la sampu cu sampu lo ka samtci`!
## 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)