readme

README.md

@@ -1,5 +1,21 @@
+sorry i will write the readme later teh school is closing
+
 # compiling the list
 
 ![the list](cover.png)
 
-sorry i will write the readme later teh school is closing
+A small writing machine to experiment the list format. It's again web-to-print, it's again flask, it's again markdown, it's again it's again it's again. I'm 30% sorry.
+
+## How to use
+
+-   Clone the repo
+-   Create a virtual environment
+-   `python3 -m venv venv`
+-   Activate the virtual environment
+-   `source venv/bin/activate`
+-   Install the dependencies
+-   `pip install -r requirements.txt`
+-   Run the script
+-   `python main.py`
+
+It will open a browser window that renders the list from the `list.md` file. You can write there. Put your images in the `img` folder.

list.md

@@ -213,9 +213,11 @@
 -   waters are shallow
 -   small text files are ok
 -   how to navigate a full thesis ?
+-   swim
 -   what about deep waters
 -   wait
 -   friendly reminder that
+-   wet
 -   thesis and the project are two different things
 -   _git_ writing workflow
 -   issues to annotate