From 9d626327fefc244e5a545cb480207ede25e8d4de Mon Sep 17 00:00:00 2001
From: = <=>
Date: Thu, 24 Aug 2023 04:17:51 +0200
Subject: [PATCH] add further indications

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 17955ee..0ad64a2 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ source venv/bin/activate
 pip install -r requirements.txt
 ```
 
-- (optional) Configure `GITHUB_USER` and `GITHUB_TOKEN` in `/app/settings.py`. This is currently only required to:
+- (optional) For a full local deployment, configure `GITHUB_USER` and `GITHUB_TOKEN` in `/app/settings.py`. This is currently only required to:
 	- override Github's unregistered user API limitation during app catalog update which prevents from updating more than about 10 entries) via `appcatalog.py`
 	- perform some maintenance watch tasks via `maintenancePing.py`
 
@@ -37,4 +37,16 @@ pip install -r requirements.txt
 ./manage.py update
 ```
 
-Note: script files located at `app/scripts/` are meant to be executed via `cron`. Therefore for local development purpose they can be triggered manually.
+- Scripts files located at `app/scripts/` are meant to be executed via `cron`. Therefore for local development purpose they can be triggered manually. For instance, to be able to display catalog news and history, run:
+
+```
+python app/scripts/appListsHistory/script.py
+```
+	- That will output a few json files at the repo root (count-history.json, news.json and news_rss.json ) that you will have to move manually to the directory `app/scripts/appListsHistory/`.
+
+- To browse the webapp locally, run from the repo root:
+
+```
+flask run
+``` 
+	- And open the URL that gets displayed in the terminal (e.g. http://127.0.0.1:5000/ ).