From c91430ef62a6634f292a3c1a86be0608735ea66a Mon Sep 17 00:00:00 2001
From: Herwin Bozet <herwin.bozet@gmail.com>
Date: Wed, 5 Mar 2025 23:59:54 +0100
Subject: [PATCH] Added new readme stub Update readme.md

---
 readme.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/readme.md b/readme.md
index 1062f1c..6d68818 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,40 @@
 # Website - NibblePoker.lu
 Public repository containing the source code for the *nibblepoker.lu* & *nibblepoker.com* websites.
 
+
+## Features
+TODO
+
+
+## Related Projects
+TODO
+
+
+## Local Setup
+Follow these steps to setup a local version of this website:
+1. Install Python 3.13
+2. Install Node JS v?
+3. Install Python Modules \
+   `pip install --upgrade -r requirements.txt`
+4. Install NPM modules \
+   `.\scripts\nodejs-setup.cmd`
+5. Compile the `.mjs` files into `.js` and `.min.js` \
+   `.\scripts\compile-js-site.cmd`
+6. [Install static files]
+7. Setup environment variables:
+   ```batch
+   :: Batch
+   set NP_HTML_POST_PROCESS=MINIFY
+   set NP_FLASK_WAITRESS=1
+   ```
+   ```bash
+   # Bash
+   NP_HTML_POST_PROCESS=MINIFY
+   NP_FLASK_WAITRESS=1
+   ```
+8. Run [app.py](app.py) \
+   `python ./app.py`
+
+
+## Licenses
+TODO