chore: update readme
This commit is contained in:
		
							parent
							
								
									cda5bc56ae
								
							
						
					
					
						commit
						af6df54f35
					
				
					 1 changed files with 2 additions and 30 deletions
				
			
		
							
								
								
									
										32
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										32
									
								
								README.md
									
										
									
									
									
								
							|  | @ -1,37 +1,9 @@ | |||
| # eòlas | ||||
| # eolas | ||||
| 
 | ||||
| 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 | ||||
| [online](https://thomasabishop.github.io/eolas). | ||||
| 
 | ||||
| ## Related projects | ||||
| 
 | ||||
| ### [neuron-zk-generator](https://github.com/thomasabishop/neuron-zk-generator) | ||||
| 
 | ||||
| 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](https://github.com/thomasabishop/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 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` | ||||
|   directory, 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 | ||||
| TBC | ||||
|  |  | |||
		Loading…
	
	Add table
		
		Reference in a new issue