consump/README.md

# consump

> it's like goodreads for *x*

CC BY 4.0 2023

## about

a convoluted pipeline of transformations that creates an html log of tv shows, podcasts, and music from a plain text database.

this is what powers <http://tilde.town/~dozens/consume/>

## features

- plain text database!
- <del>ed?</del>
- produces html/css/javascript (js for filtering content type; css for lookin good; html because don't you want to read it??)
- rss feed
- rec feed

## dependencies

- recutils: database <https://www.gnu.org/software/recutils/>
- mustache: templates <https://mustache.github.io/>
- csvjson (csvkit): transforms <https://csvkit.readthedocs.io/>
- jq: transforms <https://stedolan.github.io/jq/>
- (optional) just: just a command runner <https://github.com/casey/just>

## getting started

1. install dependencies

2. update `templates/feed.mustache` and `templates/html.mustache` to include your own links and information for the generated rss and html. update the `up` recipe in the justfile to put the generated files wherever you want them.

3. run `just new`.  or copy the 'new' script from the justfile into a bash file and run it.

4. `just html` and `just rss` will build the html and rss respectively. Again, you can cobble these together from the justfile into a bash script if you don't have/want to install just. `just build` will assemble both the html and the rss.

## resources

- https://elly.town/d/blog/2015-10-03-ed-tutorial.txt
- http://tilde.town/wiki/learn/editors/ed.html
- https://tube.tchncs.de/w/g1ZKSzvDaqbpWQQgxGfW3z
- https://anhvn.com/media/