From e41d1fc4eaf6d01bf187936986006d87b9f395b6 Mon Sep 17 00:00:00 2001 From: thomasabishop Date: Thu, 14 Nov 2024 14:13:39 +0000 Subject: [PATCH] chore: update readme --- README.md | 48 ++++++++++++++++++++++----------------------- zk/.zk/notebook.db | Bin 3858432 -> 3858432 bytes 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index ef8aef6..55de94c 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,36 @@ -# Eòlas +# eòlas -
- -> Eólas is Irish for knowledge or information, especially knowledge gained by -> experience or practice - -This repository is my technical knowledge management system or "second-brain". -It comprises notes from my autodidactic study of software engineering and -computer science. - -## Frontend +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. The notes can be read in a more congenial format -[here](https://thomasabishop.github.io/eolas). 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. +[online](https://thomasabishop.github.io/eolas). -## Implementation +## Related projects -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 -longer notes into smaller units. +### [neuron-zk-generator]() -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) -Neovim wrapper. +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. + +### [eolas-db]() + +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. ## Scripts The [scripts](/scripts) directory contains several Bash and Python scripts I use for general housekeeping, such as formatting image URLs, removing unused assets, and autosaving. + +### `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 diff --git a/zk/.zk/notebook.db b/zk/.zk/notebook.db index 536c413aa8d9b88eee19060c46efaf53468bcfd3..2ce609d295cc28f5d87e59a46d3f14892c0d81e5 100644 GIT binary patch delta 5735 zcmd5g3vgW3b?@GH-*?~Jx6-bDUfFuq+SUhs_M`oo*!Y8G3^v3zh7t_X+tpiXt<|o) zyOJ!MW-a7cF||NOz;l{UX(!`0EyK7d!y7s_mF&{x zTl&$H&uw{T3zmnLo;_Ye_bm6#21WG4rQ1*4=KIQV_=iC9*cTma>5opeqs66{Plbql zh$$}p^wgndxSjly6*~NxryWdwoCz!!A6eoAaToIxzskELF0R4C-!E-gJWhnygqN1i zEzWX>#UtVmmZN7L=Nou}6eQs4sOexlre90nvMQ)^Y0uepf^#b2;D1KkN)N<{sN=@T)SW^$I*GMeL!ZJBACn&&&feXkP*TNu?P`_c!UImBO)1 zD(C020>Z7hu4s&#{iWPTFC>Jw`f*dG1UI>S!R(*TS4aEDjq=!VX}UO<cS z%Z{4aG3Ra@W=j*UviA})Q!Sg$aTb%ZX;d9NjaWww4dHq(pQtCiV_^-r8o+Y|VLs_; zMx0r!QnSH2UBKi>z5?vV&mDv1c^b8}e_!rOTXbK|v%QW@le06*WUkw%Qbb$$*Z4q@W;V^X={yuFAN z9BqIX%WasHvMZ(?M8dc+X5Jv&!tx)9K?xHTMG$Y&h(MsRGt=!yzqG~)zLNNUY2sg9Pw0u3?| z9CQ=n%I0`!%3&IW%gM5v8U0{7M9G}1QEl!BhK9h#JjoWJRQJz)Xf3U4dw?RB9rb}9^q*hlZG%0X$uNN z0kH_TaBOMPmEHw8RR+&UP+gb=R<-%+B}I`m)uSj{gIAS2b+V!;^_t>UG_S14lFtWM zK2=dQACP%v$s=o?`J*Q|`{)V&k)X`-m{9`qD?GNnPxIHf+NoRIo<^7@4CQQ!;f|`2 zDVQB|)8Lguh>b*JbJLJQM}xFFrlC62KuaCwM~r+CB1x%k!Cawgf?FxwEKl=?9yhZP z_Gw6!!~P(x6r(ueP;6d@Nug9RDNzS_5JQqWoH0ViAp{QddJgAZ=?}78F=xI1QfJV5 z_wDvjss-VsPFR6g>w@iw3>#Hft=T%Qj$@%d=cXZB8oUZ0z$oKL4*Ic>w_f~u=js{_ z1yxRlG8;D_z?674Ok@so#cIBqcWzUdJ7SDaz%7t&XNj4Gh)hF;Y+B=K4Yso^tpciZ zONwPDO7N3F7e_+Qtb&~`+c<<33X@W`b~;4~L^b>gw<@V4`_jQ6)TJ@yQq8V+3X_W3 z1G(u`C4H!K914D%^|Z01VnVSx?nP%S zJ;WkcgEY&Q#@*yQ(%MFx)B?Q&+-x0YCu#Ojn<2=HXV5&yz8R45*Ox+JG zwP2%{W9eL(_CsS(xaLOH`tp~0q#BLx&4``Qi)p_*GumgNZOoJ=onMn? zR})Q9yk5!URXmEU*2}&|O_O~-sZLev6pyCJUR72-sz>%{Uav<|WsfX*p_eF{26#Y& zR^su?&{I5K$y-xYk5{czwYrD5pLLcR!hBYS&8q{4jk#ko!V<3{ISX4sFuGYnOcD2|~0Nm_h4l zB<{2~H;Bh%0&CXJ`HO9$eX&it^<9D+m`UJ~_gHuP9FcmNat z6~Jq^)N4Q7^I!2~wE32d515O}uv;<>Kl^}N4}0@ZZDpwOU;kF+;tXc)V3<3^ zUF;t(y?%9*eMh+I#{|@419m#zBX`(&(G?_WqAq@cPDw+vT!J zC%Rs$^wCYBud*_oJ8vAUENo^cmDbgDe^_}y4(T^`M0+CLG=r?qzQ+5lclRW=Sr>M9 zsn%So>AnAVY92*f3r08|j}3$q@mxBY%)}$Gw#Pz-aim`pg)v_Xq|r}w9~6@U|<*c?m?0VOt!fe_{oT@k=XAS^jYsdq2xRx`KK5g%wQU zPusuzPUvNX2CWybg!;Tt%%IBK2gx*G^8Bx_gzR5mStl>T3)S-s`W1SEdH&4SfYpA9 zeWLboU~#48p6CJUYkauF+4T)*XhoRD@Xf;u(g@6S0|rWeKmB5j;bHpCWu5m91F?A0 zJs36%Fo}Ul{P5L^(!D|`|K={17dKfkE4wcMunaO;CaN6>OfZJ9qA%fh ztlKZH?~&s(cj#ZRmb9Vs`~FdW zF2geQ97*ypSs0i#p>rLbUzJse0aD&#l(+1v!$bckR6Mu6;Y;;O@IV?p&64<#cEJ)<=zsZsXpPKjy1mD#C>`PkVIOz+oHI^Eo{apB3GiOQsI*t#s7YDyB@Q+=pGZN@rNU zI06DbBG4JseNN-894^SeQDaxDPt&;Sopj!rUHUy+cOTfXU+>)LKGVkC+uI9o*CUmU z`u(t$`wiNAD?K{=LBjcf;cB&cVvW|ZwY_yUnNmY5cK=)f*vEM5f7vTHoKm|nd;ZV8 zB1bZjL_8IXMI%Nm6O9|$NGxsiq|@10GMS7-)0s$gU^tT+2 z>9jw%(j_di@9~FhVWRt1#IBb7)~614pIZGz{&D_u{Ac*8G%jVOW&SVt^ZYsfkaV*Y zkvi;ahr6eUEG*O$2Da7fS*tqL9cx^ub00mzg3rYiVL`JmPIZsr#)Ssw=xs?@2)Nim zVZm>0p6TA;Ur?Qs_kmGyF~ypm>E0wQc-_bB{Kc7WfSc@#Gd(-ci3pu#;C~S|jm&&e z@3o71-&6g*Zsrk2$uqAj?Vf+~JgL24)qk>Yw>|X9zWoZ4mOAd*ZeKsx_g8pZDjYYH zaWib@vN1E9j%H(tXf!>Lh#Bd$nMma#xkz}xNDi9=sc^zDGO1J+24Q445{+k)k$4te ze}1TsTv`=lzR5`cES>WR@?Xlw(4-f{307L;|00RJV z`_v;61Kmzb^pcgp#9wOWRVwdGyz+mPX_s|Z~nG1vL0GU z_SC~FliC=GZj7h;!UKuaKqO{;cQ6>R^!h&8I{I3o&ic_pa-HZ@2GoSDJevIF83FNw Y3_pm$z@MP`_tvHW()N36H_9*mJMRwo1^@s6 delta 3030 zcmb7GeQ;FO6@T}>uYF(pHpwQN1V}c!CfUR!yZhdLrUC&apopSYN0e%IHyc<8Nl2C? zL~9ZQ*?>WVi(aeFh^6A#G7g%KuXGw3r(%)P3fQTmsKgICf?<*nMt<-t7t^>q{*^Q%ws^$H0K!nv^XA zc=F`TLu@*)c#^#Ng^NY@$z#Q{RrzOCOgmAmv%NhYOC~xydZOtQi{0p-ZH$ZJF%YnPz$ZHR@5WR7#sB%F?chq4a@?VX5DA*7R=fKdJ40lq)n{PZc8` zC)dY;%|{%DOJVvQ(u3UTRZm>S_ax(+B8)KE|HODT9Th@pe)@=!*TS`%CPQx==fD(B z^Cz5>btnF1O3%#XO@`n3!*^NF{qb?`D5ZX(9yR14bWnA02zf=CS`P{-7mzzLgyBb* zQnZK=Mu;XKJc3G18y>lTe8rC0>qaNg=mZ{}pkJ9_m`f(a3{cDf`W-}Lt;iYQ)Ri3R z)W!nV)3YT;Zhx|Fv6;t_4{C~7bEL`DV#gmEKT^NGWe$057`qvXf{gzz9H8X-^Z;{urOBJY0U zs3!7RM@bQ4;*r?;tjl7=wk5iIz@H;`o^{M0gz=Ra^}s#M_HCf65#H1~GCb8$@hRyek3@phcsZ?%s?ua2~Uru|%Xj8^sP$B5k>u z+%%nN&zWm5yEU^mve6ko6f;x9%v7cd8pX3Im+=^NjtnRWORU8~(_M*JHol5+AK1y! zbB_8F0a}e2luJ`o5$=P6LlSkQ?7XAA3Db#Wu9S-yQI^euED5qANd>Z5RuqdMm=udD zDv~1007aI}iYQB>DhP@w3Zk4E*v1+I+qj+cL?l}&*-97DMTU7VH_MXBbB>ku)@-%~ z2$%6%!F-uza3WWQ76x@>Gij$$BCBkeB2S)kY(YG+oOfu0kYxXr^g#9^9W$L<+M$i0 z_im+7Wh|;JDrN-|$)pTiQVJy5tjcDyqRJLQQ6!61G)s~qnPrd$KH#KSl#GfzRfY7; zlA4iXkt7MU2r}%DL0F!Mp>}r@$3Ct^D$FcR*~XdYNyf5$+!D;d!WtxtPuCTaXP)DV z5l4RY9Ct%jYh6xj-nUx+XQ}1iBb7wXI|`QkU+T=?p)O@Tz!}y9{G}N35!PZ_h}A=6 zsl`-pY_^ylWZ>MRn#o>dT5c>VG~FjM&CIZpnkqLLQ{}>Sml$C_)eFPKRTvkNTP@;V zW7Z;8Af}4G8K+9}MSuj50Sdrul;o?QuKJ!~Q8iT(wE*$}`G5j|)hLM;Ui>Fp1t-MA zhTKy0)tid+8ilEq6t$A|)6b_*&MY)mdTi$zW|uS)Gs1qGg(fGi57ZlF*Vt%etZB4$ zAuQfQ4wsvn$hyV08k?tH^V_{zqZVw`y$zvYI2;UyJt4AWd0>qSjlU+JTDENQ@PchO zk9v)}JhoSn@vbxU0V1a>Ln3*}XS4n{gg4OW4>Wl75X1;*;cSS}Cfh4b#f+WSk&W;z z#W9R*srHs)Knb7}Fb^;vumDg7C4cqjE_1L$$|CH>z2;|3 z%h0ppkC~qfrRFt!4Jt6_E616?ivgp3+G%C8Z8EkUaXwDxXxSUizjBNRU!cgru3D#Y z^$Dke^6>>4;W_iP`OoHK>PPC=>gVL*N#_Ppo|Q-C^YV=R7gG9`a|Jng%DLPuFc@AD zAFgE*8D_9=Irj*Kx8|&KGIz@rrgN*wi|;w_L#IgX`_8dua}m{y(O0ExH?V7fvFv7G z8nAoVE?{sX&)&t}0jvzzz3lD4tiVdy9|9ABvFvTeKi+p9LC8f8pK&%^N#*0UOkZZw z)a5fyQx84yv^zxREGL z<+DtX8;Jnnn7aMdt`{;Jg(98q`duV-(e;9H_>$|iVC<}`@1`?`Uo5fdx~6-znBNnR z`vbn9r?oArX?k3bhrB_}8}Y{?QJ+5&4@UHGz~>L>G2Q2jMm)Y&uTKm4;y%*zZJaXrt>)J)J{aY=*ks=W@Wlfot;CM*yNgdYfA zp_<&Zxpqh1uepQVe(q`RQErTTfJ<`7nB834%aEs!!-`J!*6Ky$w=xvGAm$`~{FWS( z`SI1pRB!D@Tr}37HGM4bV|_WcmLKaSi?-HQ6^w1jT0Vqli5y!?`nJ|C6vo!)ZuQjE z)>^>T#?;oj<@-&T>Y&gQR0nL`XsW|rZ*9q71v94~o(YR-I z!|gI!ovyz5T4Qc)!|(CZa5(Ps`rE=#p-`LO@AG*zPsH2m)uX|P#~*F;dIFlR2jW4! zEg159G9?d1qY*6@)BUkPs|Q_vrKN$HF7{GyQ^Eydzr>5LiuZ{=X%G5RJ}8utGP}E3 zG~b!oS;}^0yU}iUe`CV(oUyLPJwe~79-*+YNFLfvpFb*Yx ztBSZ`%B)huQ06T~Pl+Ra`P8-7E*vf=?w`k7PfPq@+NZ}fy30=mzmhl3vSVIpWHzdd6Y$eX)@enWXUIJcX} Zn4-Am%s2UGDD`zk2oN^Du4ohw{|67HIFSGV