From 7a9e2297d3e57ee9742d4689baffce171c2cfc38 Mon Sep 17 00:00:00 2001 From: Anish Lakhwara Date: Fri, 18 Mar 2022 01:03:06 +1000 Subject: [PATCH] readme updates --- readme.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index f7a0454..4b8e08e 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,8 @@ # Basant I collect a lot of information. Basant is a tool to help me refine, reflect and understand the vast troves of data I generate. -Think of it like a unified front end to all the data sources I have. From these vairous outputs can be created, with the end goal eventually being a matrix bot to publish to The Feed, a front page showing latest changes, and of course, my website. +Think of it like a unified front end to all the data sources I have. +From these vairous outputs can be created, with the end goal being a variety of ways to viualize, understand and share my data: matrix bot to publish to The Feed, a front page showing latest changes, and of course, my website. I'd like to be able to draw 'links' or annotations between the tags I use across various different pieces of software, These are the tools I use construct the space. @@ -16,11 +17,14 @@ Some of those HTML files get published For better ideas look into [HPI](https://github.com/karlicoss/hpi) and how it's structured -### Inputs -`kitaab-public` requires a local copy, stored in /home/anish/vimwiki/ -there needs to be a .vimwiki_tags file there (which can be built in vimwiki using `:VimwikiRebuildTags`; how to automate this?) +### Grab +Currently `kitaab-public` requires a local copy of unfiltered kitaab stored in ~/vimwiki. + +However, flakes can use private git repos, so maybe there's a way to build this bit too using nix?? TODO +there needs to be a .vimwiki_tags file there (which can be built in vimwiki using `:VimwikiRebuildTags`; how to automate this?) TODO + It'll grab the relevant files, censor them, and then add them to raw/ -`kitaab` should run the same thing, but without the filtering and censoring +`kitaab-local` should run the same thing, but without the filtering and censoring streams is a big TODO - wallabag @@ -36,8 +40,5 @@ depending on the file location (which is in turn determined by input source) a s links get made and it saves it to output - ### Publish -TODO -some nix concotion that grabs the HTML and publishes it to anish.lakhwara.com - +packaged `devShell`, `module` and `derivation` for basant created, but not quite working yet. Slowly understanding more about nix, but down a terrible rabbit-hole now with python and setuptools...