From 7ab12023c30711974931f916075ed75e8891b80b Mon Sep 17 00:00:00 2001 From: bronsen Date: Mon, 16 Feb 2026 21:23:08 +0100 Subject: [PATCH 1/2] doc: refine release instructions Well, we are only tagging and not yet actually releasing. ny;ml: not yet; maybe later --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 77c0da9..cbe3ecf 100644 --- a/README.md +++ b/README.md @@ -96,8 +96,12 @@ Please no: this is my little human-created thing. * make code changes * run tests; make them pass * commit -* `git tag vX.Y.Z` -* push commits and tags +* `uv version X.Y.Z` +* commit +* push commits +* use lazygit to create the new version tag + * remeber to prefix it with `v` +* push the tags, using lazygit `uv build` will now create correctly named tar balls and wheels. From 9728e764e9416b1c1907381d403fb0c27b6b2655 Mon Sep 17 00:00:00 2001 From: bronsen Date: Tue, 17 Feb 2026 21:17:20 +0100 Subject: [PATCH 2/2] doc: fix typos in README --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index cbe3ecf..a5f2c01 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ This is a little TUI based on [Textual] for entering new Teilchen and for searching for existing Teilchen. Data is kept in a sqlite database. +It is not yet usable. + ## Running tests ```sh @@ -19,7 +21,7 @@ You will need two terminals: 1. one for showing the console, 2. the other to run the app. -Since we use uv, the incantation is bit different from the official documenation: +Since we use uv, the incantation is a bit different from the [official documenation]. In one terminal: @@ -36,9 +38,10 @@ uv run textual run --dev src/teilchensammler_cli/__init__.py ## Developing -To re-create bronsen's development environment, you need several shiny new toys: +To re-create bronsen's development environment, sort of, you need several shiny +new toys: -* [just] to run the recipes from `justfile` (think Makefile, but easier) +* [just] to run the recipes from `justfile` * [uv] for all the python executing stuff, also venv * [prek] as a replacement for pre-commit * [ruff] to lint and format the python code @@ -69,11 +72,11 @@ unwieldy. ## Bug Reports, Feature Requests -Create them [under "Issues"] at the top the [repo page]. Do not worry too much -about labels. +Create them by clicking "Issues" at the top of the [repo page]. Do not worry +too much about labels. -Please be specific and provide logs, screenshots, a test that replicates the -problem. +Please be specific and provide logs, screenshots, or even a test that +replicates the problem. ### Architectural Changes @@ -87,30 +90,31 @@ I'll make an effort to update those to the best of my capabilities. ## AI -Please no: this is my little human-created thing. +Please don't: this is my little human-created thing. ## Creating a new release (This is so bronsen can forget.) -* make code changes -* run tests; make them pass +* run tests; make sure they pass * commit -* `uv version X.Y.Z` +* `uv version --bump {segment}` + + Where `segment` is one of: major, minor, patch, stable, alpha, beta, rc, + post, dev * commit * push commits * use lazygit to create the new version tag - * remeber to prefix it with `v` + * remember to prefix it with "v" * push the tags, using lazygit -`uv build` will now create correctly named tar balls and wheels. - ---- +[official documenation]: https://textual.textualize.io/guide/devtools/#console [Textual]: https://textual.textualize.io/ [uv]: https://astral.sh/uv [just]: https://just.systems/ [prek]: https://prek.j178.dev/ [ruff]: https://astral.sh/ruff [markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2 -[under "Issues"]: https://code.c-base.org/infuanfu/teilchensammler-cli/issues/new +[repo page]: https://code.c-base.org/infuanfu/teilchensammler-cli