chore: update readme

This commit is contained in:
thomasabishop 2024-10-24 17:42:50 +01:00
parent 672eae2cea
commit a3d6839c29

View file

@ -9,6 +9,15 @@ This repository is my technical knowledge management system or "second-brain".
It comprises notes from my autodidactic study of software engineering and It comprises notes from my autodidactic study of software engineering and
computer science. computer science.
## Frontend
The notes can be read in a more congenial format
[here](https://thomasabishop.github.io/eolas/cfbef1c4_web_precursors). This is a
[Neuron](https://neuron.zettel.page/) static site that I generate automatically
using a small Python
[application](https://github.com/thomasabishop/neuron-zk-generator) that
executes on each push to this repository and deploys via GitHub pages.
## Implementation ## Implementation
It is a [Zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) work in It is a [Zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) work in
@ -18,9 +27,7 @@ longer notes into smaller units.
I use the [zk](https://github.com/zk-org/zk) CLI package to help with indexing I use the [zk](https://github.com/zk-org/zk) CLI package to help with indexing
and task automation alongside its [zk-nvim](https://github.com/zk-org/zk-nvim) and task automation alongside its [zk-nvim](https://github.com/zk-org/zk-nvim)
Neovim wrapper. I occassionally utilise [Obsidian](https://obsidian.md/) Neovim wrapper.
alongside Neovim for when I want to view my notes as a knowledge graph or read
them alongside their rich content (images, videos etc).
## Scripts ## Scripts