commit e5e3c787a86c5a21c13802f9606c9b84b7c7a0ac
parent 0ad9cedbc3b07b66408fd87bb99246053f4e1b20
Author: Daniel Barlow <dan@telent.net>
Date: Wed, 23 Jul 2025 17:53:59 +0100
rewrite README
Diffstat:
| M | README.md | | | 35 | ++++++++++++++--------------------- |
1 file changed, 14 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
@@ -1,28 +1,21 @@
-# What's the plan?
+# Cripslock
-0. read frontmatter. should we convert this to yaml?
- probably not worth it
-1. Read a directory full of markdown/textile files
+> "'We're going to have to get Mr Cripslock to engrave page 11 again,' he said mournfully. 'He's spelt "famine" with seven letters --'"
-*
-(lcmark.convert "hello *world*" "html" { :yaml_parser #($1) })
-"<p>hello <em>world</em></p>
-" {}
+Cripslock is named after the Discworld engraver who appears in "Maskerade"
+and his grand daughter Sacharissa.
+It's going to be a sort of a cross between a blog and a wiki but I'm
+working on the blog aspects first
-2. index them by title
-4. make summaries from frontmatter or first para
-5. for each hashtag in each file, add it to a list
+## State
-6. start an http server, answer requests:
+Not yet usable
-https://github.com/daurnimator/lua-http/blob/master/examples/serve_dir.lua
+### TODO
-** for /, paginate files in rev date order and show summary
-** for /yyyy/mm, all the files with pub date in that month
-** for /slug, the page with that filename (assuming it's unambiguous)
-** for /yyyy/mm/slug, display as per slug
-** for /#tagname, search hashtags for files, paginate summaries
-** for /edit/slug, an edit form
-** for /new/, also the edit form but slug is editable as well
-** ?content-type=rss on any page produces an rss version of that page
+* summaries / some way to signify "after the cut"
+* hashtags
+* rss
+* editing?
+* how to surface "timeless" pages