eolas/README.md

37 lines
1.2 KiB
Markdown
Raw Normal View History

2024-11-14 14:13:39 +00:00
# eòlas
2024-02-17 16:58:09 +00:00
2024-11-14 14:13:39 +00:00
This repository is my technical knowledge management system,
[zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) or "second-brain",
comprising notes from my study of software engineering and computer science.
2024-11-14 14:13:39 +00:00
The notes can be read in a more congenial format
[online](https://thomasabishop.github.io/eolas).
2024-02-17 17:56:14 +00:00
2024-11-14 14:13:39 +00:00
## Related projects
2024-10-24 17:42:50 +01:00
2024-11-14 14:13:39 +00:00
### [neuron-zk-generator]()
2024-10-24 17:42:50 +01:00
2024-11-14 14:13:39 +00:00
Converts notes in this repository into a format that can be compiled into a
[Neuron](https://neuron.zettel.page/) project and published to the Web.
2024-02-17 16:58:09 +00:00
2024-11-14 14:13:39 +00:00
### [eolas-db]()
2024-02-17 16:58:09 +00:00
2024-11-14 14:13:39 +00:00
A database for the entries which I use to track changes and relations between
notes. Also serves as the back-end for further transformations/utilities.
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.
2024-11-14 14:13:39 +00:00
### `auto-commit.sh`
This is the main script for managing the project:
- standardises file names and purges unused resources
- compiles the Neuron version of the project, writing to the `/neuron`, which is
then deployed to the Web via GitHub actions and GitHub pages
- triggers the reindexing of the `eolas-db` database
- commits all changes to this repository with a timestamp