From d95693b1cfbc8ba6252e44b3c353eef16c3d7943 Mon Sep 17 00:00:00 2001 From: nate smith Date: Sun, 18 Aug 2024 23:16:15 -0500 Subject: [PATCH] fix readme --- README.md | 29 +++++------------------------ 1 file changed, 5 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 6e85411..ee14c79 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,14 @@ # Trunkless -_being a web-based tool for making cut-up poetry using the entire1 Project Gutenberg collection of English books._ +_being a web-based tool for making cut-up poetry using very large corpora_ + Trunkless is a spiritual successor to [prosaic](https://github.com/vilmibm/prosaic). This repository contains code for: -- processing the Gutenberg corpus -- creating and accessing a large `postgresql`-stored corpus of lines +- processing source material +- inserting cutup phrases into `postgresql` - hosting a web front-end -The actual Gutenberg collection of books can be found at [The Internet Archive](https://archive.org/details/pg_eng_txt_2024). - -## TODO - -- [X] ingest - - [X] strip header/footer - - [X] emit clean lines of appropriate length - - [X] associate lines with book metadata - - [X] db schema -- [X] server - - [X] `/` - - [X] `/line` -- [O] front-end - - [X] dark/light mode toggle - - [ ] cookie for dark/light mode - - [X] editing interface - - [X] save feature (as plaintext, as image) - - [X] `htmx` or just raw ajax for accessing `/line` - - [X] font and icon styling - -_1 as of January, 2024_ +To learn more, check out [this blog post](https://tilde.town/~vilmibm/blog/#announcing-trunkless).