summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Okay <59481711+cbeo@users.noreply.github.com>2021-06-09 18:08:00 -0500
committerGitHub <noreply@github.com>2021-06-09 18:08:00 -0500
commit95b2090e21f7aada157f07b9cda809a756865993 (patch)
treeef18fa87a8c05544a2403de3b670e69110907e2c
parent5e3a745a8b6df0934c1331a03e60c399598b36d3 (diff)
Update README.md
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
index 696e8cd..e771433 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,38 @@
# flexo
+*alpha quality software*
+
The Common Lisp, interactive system for static site generation.
+For an example of a site made with flexo, see [my site's source](https://github.com/cbeo/hyperthings.garden)
+
+The idea is this:
+
+1. You make a recipe that builds your site
+2. The recipe first adds "resources", which are usually files on disk
+3. The recipie then uses those resources to build "artifacts", which are mostly pages.
+4. You then publish and deploy.
+
+## Interactive development
+
+The real benefit of flexo is interactive development.
+
+If you run the function
+
+ (hack-on 'my-site-recipe #P/tmp/flexo-hack-space/" :port 4242)
+
+The you can do things like add new resources and recompile the functions that build artifact and the site will automatically redisplay.
+
+## Future development
+
+- Separate `spinneret`, `LASS`, and `parenscript` template macros into their own packages
+- Document the CLOS Protocol that Flexo uses, including how to extend it to:
+ - Make your own artifacts
+ - Make your own resources
+ - Make your own deployment styles
+- Add resources as:
+ - Entire separate document trees for importing "subsites"
+ - Database Queries as resources, not just files
+ - API calls as resources, not just files
+
+