diff --git a/README.md b/README.md index 85a1be8..f8b2b2b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Konfluks logo is a stylized and schematic representation of a drainage basin](docs/Konfluks.svg) +![Konfluks logo is a stylized and schematic representation of a drainage basin](https://git.autonomic.zone/r/konfluks/raw/branch/konfluks-renaming/docs/konfluks.svg) # Konfluks @@ -25,34 +25,36 @@ Konfluks is extendable, a work in progress and a messy undertaking. Konfluks consists of different Python scripts which each poll a particular service, say, a Peertube server, to download information and convert it in to [Hugo Page Bundles](https://gohugo.io/content-management/page-bundles/) Each script part of Konfluks will essentially to the following: - * Parse a source and request posts/updates/videos/a feed - * Taking care of publish ques - * Create a Hugo post for each item returned, by: - * Making a folder per post in the `output` directory - * Formatting post metadata as [Hugo Post Frontmatter](https://gohugo.io/content-management/front-matter/) in a file called `index.md` - * Grabbing local copies of media and saving them in the post folder - * Adding the post content to `index.md` - * According to jinja2 templates (see `Konfluks/templates/`) +* Parse a source and request posts/updates/videos/a feed + * Taking care of publish ques +* Create a Hugo post for each item returned, by: + * Making a folder per post in the `output` directory + * Formatting post metadata as [Hugo Post Frontmatter](https://gohugo.io/content-management/front-matter/) in a file called `index.md` + * Grabbing local copies of media and saving them in the post folder + * Adding the post content to `index.md` + * According to jinja2 templates (see `Konfluks/templates/`) The page bundles created, where possible, are given human friendly names. Here is a typical output structure: -`user@server: ~/Konfluks/output: tree tv/ -tv/ -├── forum-27an-mother-earth-353f93f3-5fee-49d6-b71d-8aef753f7041 -│   ├── 86ccae63-3df9-443c-91f3-edce146055db.jpg -│   └── index.md -├── keroncong-tugu-cafrinho-live-at-ruru-gallery-ruangrupa-jakarta-19-august-2014-e6d5bb2a-d77f-4a00-a449-992a579c8c0d -│   ├── 32291aa2-a391-4219-a413-87521ff373ba.jpg -│   └── index.md -├── lecture-series-1-camp-notes-on-education-8d54d3c9-0322-42af-ab6e-e954d251e076 -│   ├── 0f3c835b-42c2-48a3-a2a3-a75ddac8688a.jpg -│   └── index.md -` +``` + user@server: ~/Konfluks/output: tree tv/ + tv/ + ├── forum-27an-mother-earth-353f93f3-5fee-49d6-b71d-8aef753f7041 + │   ├── 86ccae63-3df9-443c-91f3-edce146055db.jpg + │   └── index.md + ├── keroncong-tugu-cafrinho-live-at-ruru-gallery-ruangrupa-jakarta-19-august-2014-e6d5bb2a-d77f-4a00-a449-992a579c8c0d + │   ├── 32291aa2-a391-4219-a413-87521ff373ba.jpg + │   └── index.md + ├── lecture-series-1-camp-notes-on-education-8d54d3c9-0322-42af-ab6e-e954d251e076 + │   ├── 0f3c835b-42c2-48a3-a2a3-a75ddac8688a.jpg + │   └── index.md +``` -## hacking + +## Hacking Install [poetry](https://python-poetry.org/docs/#osx--linux--bashonwindows-install-instructions):