initial: add README

1 files changed, 73 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa7cfcd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,73 @@
+# sent-web
+
+> 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. 
+
+## features
+
+- **sent-compatible format** — paragraphs = slides, `#` comments, `@image`
+  slides, `\` escapes
+- **keyboard navigation** — arrow keys, hjkl, space, enter, backspace, pgup/pgdn
+  (same as sent)
+- **mouse navigation** — left-click right half = next, left half = prev, scroll
+  wheel
+- **image upload** — upload images and insert `@filename` references
+- **export** — download as `.sent` file for local sent, or export `.pdf` for portability
+
+## usage
+
+### docker compose (recommended)
+
+```sh
+docker compose up -d
+```
+
+Open [http://localhost:3000](http://localhost:3000).
+
+### docker build
+
+```sh
+docker build -t sent-web .
+docker run -d -p 3000:3000 --init --name sent-web sent-web
+```
+
+### presentation shortcuts
+
+| key                                          | action   |
+|----------------------------------------------|----------|
+| `F5`                                         | present  |
+| `Escape` / `q`                               | exit     |
+| `→` `↓` `Space` `Enter` `l` `j` `n` `PgDn`   | next     |
+| `←` `↑` `Backspace` `h` `k` `p` `PgUp`       | previous |
+
+### sent format
+
+```
+first slide title
+
+second slide
+with multiple lines
+
+# this is a comment (ignored)
+
+@image.png
+
+\@this line starts with a literal @
+
+\
+```
+
+## technology
+
+- **PHP 8.3** — no framework, just `.php` files
+- **vanilla JavaScript** — no npm, no webpack, no react
+- **[noir.css](https://github.com/kj-sh604/noir.css)** — classless CSS
+- **Apache** — serves it all
+- **fontconfig** — `fc-list` for font enumeration
+- **Docker** — containerized with fonts pre-installed
+
+## license
+
+MIT