From 072ad8a1ab904fc348328de6a12e1b4b6b8b564c Mon Sep 17 00:00:00 2001
From: vitrinekast <vitrinekast@raspberrypi>
Date: Fri, 22 Mar 2024 08:59:45 +0000
Subject: [PATCH] update readme

---
 README.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9168d03..79a93d9 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,14 @@
 
 ## Overview of the project structure
 
-- fonts 
-- log-books
\ No newline at end of file
+- fonts *(assets for the web view)*
+- log-books *(EPUB exports of the annotated logs, accessed by ereaders)*
+- logs *(HTML exports of the annotated logs)*
+- templates *(contains 2 jinja templates, one for epub, one for the webview)*
+- book.html *(Is the most recent input for the epub, is generated by the python script)*
+- index.html *(The most recent HTML webview, generated by the python script)*
+- logged_book.epub *(Is the most recent epub)*
+- print.css *(stylesheet used when generating the epub)*
+- script.js/style.css *(assets for the webview)*
+- script.py *(The main script for generating the files)*
+- test-page.html *(A page with various HTML elements, to be tested on ereader browsers)*