From 1dd2bce5c4d51ea663b0422400c72ffa77a2b69d Mon Sep 17 00:00:00 2001 From: klemek Date: Sat, 7 Nov 2026 15:55:15 +0100 Subject: [PATCH] docs(README): add dev docs --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index af5f6aa..c312b24 100644 --- a/README.md +++ b/README.md @@ -42,3 +42,35 @@ See [1 bit by Crystalwarrior](https://alex-noir.itch.io/1-bit-by-cw) ### Pmlomb See [8x8 1 bit pixel set](https://opengameart.org/content/8x8-1-bit-pixel-set) + +## Development + +### Makefile + +```txt +Usage: make [target1] [target2] ... + +Commands/Targets: +help show this message +install install project +update update project dependencies +run run project +format format project +lint lint project +build build project +uv-sync uv sync +uv-upgrade uv sync upgrade +uv-run uv run (project) +ruff ruff check +ruff-fix ruff check (and fix) +ruff-format ruff format +ruff-format-check ruff format (check only) +ty ty check +release-% release major/minor/patch +``` + +### TODO + +* [ ] Initial implementation +* [ ] Custom height glyph map +* [ ] Custom width glyph map