eolas/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2024-10-16 18:16:25 +01:00
# Eòlas
2024-02-17 16:58:09 +00:00
<img src='./img/knowledge_graph.png' width=400 align='center' /><br/>
2024-02-17 16:58:09 +00:00
> Eólas is Irish for knowledge or information, especially knowledge gained by
> experience or practice
2024-02-17 17:56:14 +00:00
This repository is my technical knowledge management system or "second-brain".
It comprises notes from my autodidactic study of software engineering and
computer science.
2024-10-24 17:42:50 +01:00
## Frontend
The notes can be read in a more congenial format
2024-10-24 17:43:39 +01:00
[here](https://thomasabishop.github.io/eolas). This is a
2024-10-24 17:42:50 +01:00
[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.
2024-02-17 17:56:14 +00:00
## Implementation
2024-02-17 16:58:09 +00:00
2024-02-26 19:58:39 +00:00
It is a [Zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) work in
progress. I've recently converted the topic-based subdirectories into a single
flat directory structure organised by tags. I'm in the process of partitioning
2024-06-16 18:45:04 +01:00
longer notes into smaller units.
2024-02-17 16:58:09 +00:00
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)
2024-10-24 17:42:50 +01:00
Neovim wrapper.
2024-02-17 17:56:14 +00:00
## Scripts
The [scripts](/scripts) directory contains several Bash and Python scripts I use
for general housekeeping, such as formatting image URLs, removing unused assets,
2024-02-26 19:58:39 +00:00
and autosaving.