add: readme

2024-08-05 21:23:54 +02:00 · 2024-08-05 21:23:54 +02:00 · 83cb246073
commit 83cb246073
parent 6dfb15c271
1 changed files with 12 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,12 @@
+# My Readings
+A script to generate a static book review page
+
+## images
+
+## usage
+
+- fill the ![constructor.json](./constructor.json) like the ![constructor.json](./constructor_example.json)
+- run the python script
+```sh
+python main.py > index.html
+```