From 24ed1112bd5fa61a280ce62f341927fce670443f Mon Sep 17 00:00:00 2001
From: Mathieu Loiseau <mathieu.loiseau@liris.cnrs.fr>
Date: Thu, 22 Jun 2023 15:21:54 +0200
Subject: [PATCH] improve readme

---
 README.md          |  23 ++++++++++++++---------
 wikstraktor.sqlite | Bin 53248 -> 53248 bytes
 2 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 1f80c7c..0340cd8 100644
--- a/README.md
+++ b/README.md
@@ -14,16 +14,21 @@ This project does depend on python packages.
 * [``wikitextparser``](https://github.com/5j9/wikitextparser) can parse mediawiki pages and extract sections, templates and links
     * [documentation](https://wikitextparser.readthedocs.io/en/latest/#api-reference)
 * [``importlib``](https://docs.python.org/3/library/importlib.html) : to import parser modules
+* [``sqlite3``](https://docs.python.org/3/library/sqlite3.html) For logs
+* [``gitpython``](https://gitpython.readthedocs.io/en/stable/) for logs
+* [``json``](https://docs.python.org/3/library/json.html) for json use
+* [``re``](https://docs.python.org/3/library/re.html)
 
 ## Installation
 (maybe to be replaced by an automation of some sort, using a virtual environment might be better, see [server version](#wikstraktor-server))
-* [```pip install pywikibot```](https://pypi.org/project/pywikibot/)
-* [```pip install wikitextparser```](https://pypi.org/project/wikitextparser/)
-* [```pip install gitpython```](https://gitpython.readthedocs.io/en/stable/)
-* [```pip install sqlite3```](https://docs.python.org/3/library/sqlite3.html) Might be provided with python
-* [```pip install importlib```](https://pypi.org/project/importlib/)  
-_Optional (for python 2.*, not tested)_
-* run ``./setup.py`` (used to store wikstraktor version in wiktionary extracts)
+
+### Basic version
+```bash
+python3 -m venv wikstraktorenv #optional for basic version
+. wikstraktorenv/bin/activate #activate environment (optional)
+pip install -r requirements.txt
+run ./setup.py
+```
 
 ### Wikstraktor Server
 If you want wikstraktor as a server, you need to install [flask](https://flask.palletsprojects.com/en/2.0.x/installation/) and [flask-cors](https://flask-cors.readthedocs.io/en/latest/) — to allow other domains to query —, and best practice is to do so in a [virtual environment](https://docs.python.org/3/library/venv.html#module-venv).
@@ -32,8 +37,8 @@ The following commands are extracted from the aforementionned documentation, it
 ```bash
 python3 -m venv wikstraktorenv #create wikstraktorenv environment
 . wikstraktorenv/bin/activate #activate environment
-pip install Flask #install Flask
-pip install -U flask-cors #install Flask cors
+pip install -r server_requirements.txt
+run ./setup.py
 ```
 
 ## Use
diff --git a/wikstraktor.sqlite b/wikstraktor.sqlite
index a41143a79f6220cd37a258a2b105deb621a15baf..ec099cb48da8c81ff59a6a675e4fa9f091455675 100644
GIT binary patch
delta 696
zcmZozz}&Ead4e?K{)sZqjQckxEZHx?#deN?Uz*R5*M%pPJA<o|a{|X=_HAtEHWqGT
zQ*2CWwBs_46%>?Y32jU_GB7gMH89gPGEy)wvobXXqRBSrb+`%=i}F({Spu@vCl{W#
z;sA1M@@rBmCvS|<Vl<lE7_6$0*=P$kMiyvHE`~8CW*}pDic-r`i;5F-SQ6)oPj2)y
z<DYYSg2u_6n#Ct)=F}A18l#wJ12#_?tFw&FLFVyi<|XInr5BZEmQ=FDmA3)irY~HR
znpcyVR|Ax&0m{^5)|7yqIr)s2nnG%$HQbS@7>+cu06Q|JvbZF_ATyCA()a<$k=!#+
zbrocuoC$QG$>heB0SeiTR$x<9flkZBG{pd9ia=^bVtRUNQDRAEejbZ6cO%GcA|SV=
zR@5Y>*8rtz5^F$`AU}g0m)U3uHx`TIa2VU@Y08s&a@DEklQZ*xE;L07!t6#1xPh4N
ZG&CXGo#t?3G2MyFSlsU1Y;^7%BLG3p<n90f

delta 37
tcmZozz}&Ead4e?K_K7mijN3OREZNV&#AnFBFU@DTu~3z7v*Ee(i~#TR3{L<6

-- 
GitLab