diff options
| author | kj_sh604 | 2026-03-16 14:23:06 -0400 |
|---|---|---|
| committer | kj_sh604 | 2026-03-16 14:23:06 -0400 |
| commit | d497ccd6ee5428ecfa649a7d7b735baad5d453bb (patch) | |
| tree | 5b244c18193da100a88904536bf1496392339f65 | |
| parent | b28b79e99147070083e7ff309dee7f3615713eb6 (diff) | |
refactor: README.mdrefactor/rewrite
| -rw-r--r-- | README.md | 24 |
1 files changed, 12 insertions, 12 deletions
| @@ -11,14 +11,14 @@ using Python and vanilla JavaScript. | |||
| 11 | 11 | ||
| 12 | ## features | 12 | ## features |
| 13 | 13 | ||
| 14 | - **sent-compatible format** — paragraphs = slides, `#` comments, `@image` | 14 | - **sent-compatible format** - paragraphs = slides, `#` comments, `@image` |
| 15 | slides, `\` escapes | 15 | slides, `\` escapes |
| 16 | - **keyboard navigation** — arrow keys, hjkl, space, enter, backspace, pgup/pgdn | 16 | - **keyboard navigation** - arrow keys, hjkl, space, enter, backspace, pgup/pgdn |
| 17 | (same as sent) | 17 | (same as sent) |
| 18 | - **mouse navigation** — left-click right half = next, left half = prev, scroll | 18 | - **mouse navigation** - left-click right half = next, left half = prev, scroll |
| 19 | wheel | 19 | wheel |
| 20 | - **image upload** — upload images and insert `@filename` references (50 MB cap) | 20 | - **image upload** - upload images and insert `@filename` references (50 MB cap) |
| 21 | - **export** — download as `.sent` file for local sent, or export `.pdf` for portability | 21 | - **export** - download as `.sent` file for local sent, or export `.pdf` for portability |
| 22 | ## usage | 22 | ## usage |
| 23 | 23 | ||
| 24 | ### docker compose (recommended) | 24 | ### docker compose (recommended) |
| @@ -84,13 +84,13 @@ with multiple lines | |||
| 84 | 84 | ||
| 85 | ## technology | 85 | ## technology |
| 86 | 86 | ||
| 87 | - **Python 3.12+** — Flask backend | 87 | - **Python 3.12+** - Flask backend |
| 88 | - **vanilla JavaScript** — no npm, no webpack, no react | 88 | - **vanilla JavaScript** - no npm, no webpack, no react |
| 89 | - **[noir.css](https://github.com/kj-sh604/noir.css)** — classless CSS | 89 | - **[noir.css](https://github.com/kj-sh604/noir.css)** - classless CSS |
| 90 | - **Gunicorn** — production WSGI server | 90 | - **Gunicorn** - production WSGI server |
| 91 | - **fontconfig** — `fc-list` for font enumeration | 91 | - **fontconfig** - `fc-list` for font enumeration |
| 92 | - **python-magic + libmagic** — content-based upload type checks | 92 | - **python-magic + libmagic** - content-based upload type checks |
| 93 | - **Docker** — containerized with fonts pre-installed | 93 | - **Docker** - containerized with fonts pre-installed |
| 94 | 94 | ||
| 95 | ## license | 95 | ## license |
| 96 | 96 | ||