From 89e23cd7cd5a54383a8e6619e0ddc623e20b17c5 Mon Sep 17 00:00:00 2001
From: Castro0o <andre@andrecastro>
Date: Mon, 3 Feb 2020 15:22:48 +0100
Subject: [PATCH] README + change script name

---
 README.md                                | 30 ++++++++++++++++--------
 generate_index.py => publication2html.py |  0
 2 files changed, 20 insertions(+), 10 deletions(-)
 rename generate_index.py => publication2html.py (100%)

diff --git a/README.md b/README.md
index 564f230..3fa6139 100644
--- a/README.md
+++ b/README.md
@@ -32,15 +32,25 @@ mypassword
 ## Run
 * all toguether `./run.sh`
 
-* `python3 download_imgs.py` 
-    * Downloads all images from wiki to `images/` directory 
-    * and stores each image's metadata to `images.json`
-* `python3 images2html.py`
-    * cycles through the items in `images.json`
-    * querying the File: wiki for image
-    * if it contains essential metadata: Title, Page, Total Pages
-        * retrieves its text content
-        * generates a HTML page from it
-        * saves page onto `static_html/` directory
+`python3 download_imgs.py` 
+* Downloads all images from wiki to `images/` directory 
+* and stores each image's metadata to `images.json`
+
+`python3 publication2html.py`
+* with ask API perform a query: 
+    * default `[[File:+]][[Title::+]][[Date::+]]|?Title|?Date|?Part|sort=Date,Title,Part|order=asc,asc,asc`  
+* The results, with the same Title, are stored
+    * into 1 single HTML
+    * sorted by Part
+
+OR
+
+`python3 images2html.py`
+* cycles through the items in `images.json`
+* querying the File: wiki for image
+* if it contains essential metadata: Title, Page, Total Pages
+    * retrieves its text content
+    * generates a HTML page from it
+    * saves page onto `static_html/` directory
 
 ## TODO: Work on making an overview!
\ No newline at end of file
diff --git a/generate_index.py b/publication2html.py
similarity index 100%
rename from generate_index.py
rename to publication2html.py