From 3cbe7f72f0d85d95d61b2703087fc592318f3495 Mon Sep 17 00:00:00 2001
From: kj_sh604
Date: Mon, 16 Mar 2026 14:03:16 -0400
Subject: refactor: 24.04 vps compatibility and README re-write

---
 README.md | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 140f679..73e02b1 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 > suckless's sent tool ported to the very sucky web world
 
 A web-based reimplementation of [suckless sent](https://tools.suckless.org/sent/)
-using pure PHP and vanilla JavaScript.
+using Python and vanilla JavaScript.
 
 <img width="1280" height="800" alt="sent0" src="https://github.com/user-attachments/assets/0c503bd4-3609-4e36-ae23-77b7f0711736" />
 <br><br>
@@ -17,9 +17,8 @@ using pure PHP and vanilla JavaScript.
   (same as sent)
 - **mouse navigation** — left-click right half = next, left half = prev, scroll
   wheel
-- **image upload** — upload images and insert `@filename` references
+- **image upload** — upload images and insert `@filename` references (50 MB cap)
 - **export** — download as `.sent` file for local sent, or export `.pdf` for portability
-
 ## usage
 
 ### docker compose (recommended)
@@ -37,6 +36,26 @@ docker build -t sent-web .
 docker run -d -p 3000:3000 --init --name sent-web sent-web
 ```
 
+### local python run (without docker)
+
+Requirements:
+
+- Python `3.12+`
+- `fontconfig` (`fc-list` must be available)
+- `libmagic` runtime (`libmagic1` on Ubuntu)
+
+Setup:
+
+```sh
+cd src
+python3.12 -m venv .venv
+. .venv/bin/activate
+pip install -r requirements.txt
+gunicorn --bind 0.0.0.0:3000 --workers 2 app:app
+```
+
+Then open [http://localhost:3000](http://localhost:3000).
+
 ### presentation shortcuts
 
 | key                                          | action   |
@@ -65,11 +84,12 @@ with multiple lines
 
 ## technology
 
-- **PHP 8.3** — no framework, just `.php` files
+- **Python 3.12+** — Flask backend
 - **vanilla JavaScript** — no npm, no webpack, no react
 - **[noir.css](https://github.com/kj-sh604/noir.css)** — classless CSS
-- **Apache** — serves it all
+- **Gunicorn** — production WSGI server
 - **fontconfig** — `fc-list` for font enumeration
+- **python-magic + libmagic** — content-based upload type checks
 - **Docker** — containerized with fonts pre-installed
 
 ## license
-- 
cgit v1.2.3