Compare commits

..

2 commits

Author SHA1 Message Date
bronsen
9728e764e9 doc: fix typos in README
All checks were successful
ci/woodpecker/push/workflow Pipeline was successful
2026-02-17 21:17:20 +01:00
bronsen
7ab12023c3 doc: refine release instructions
Well, we are only tagging and not yet actually releasing.

ny;ml: not yet; maybe later
2026-02-16 21:23:08 +01:00

View file

@ -3,6 +3,8 @@
This is a little TUI based on [Textual] for entering new Teilchen and for 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. searching for existing Teilchen. Data is kept in a sqlite database.
It is not yet usable.
## Running tests ## Running tests
```sh ```sh
@ -19,7 +21,7 @@ You will need two terminals:
1. one for showing the console, 1. one for showing the console,
2. the other to run the app. 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: In one terminal:
@ -36,9 +38,10 @@ uv run textual run --dev src/teilchensammler_cli/__init__.py
## Developing ## 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 * [uv] for all the python executing stuff, also venv
* [prek] as a replacement for pre-commit * [prek] as a replacement for pre-commit
* [ruff] to lint and format the python code * [ruff] to lint and format the python code
@ -69,11 +72,11 @@ unwieldy.
## Bug Reports, Feature Requests ## Bug Reports, Feature Requests
Create them [under "Issues"] at the top the [repo page]. Do not worry too much Create them by clicking "Issues" at the top of the [repo page]. Do not worry
about labels. too much about labels.
Please be specific and provide logs, screenshots, a test that replicates the Please be specific and provide logs, screenshots, or even a test that
problem. replicates the problem.
### Architectural Changes ### Architectural Changes
@ -87,26 +90,31 @@ I'll make an effort to update those to the best of my capabilities.
## AI ## AI
Please no: this is my little human-created thing. Please don't: this is my little human-created thing.
## Creating a new release ## Creating a new release
(This is so bronsen can forget.) (This is so bronsen can forget.)
* make code changes * run tests; make sure they pass
* run tests; make them pass
* commit * commit
* `git tag vX.Y.Z` * `uv version --bump {segment}`
* push commits and tags
`uv build` will now create correctly named tar balls and wheels. 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
* remember to prefix it with "v"
* push the tags, using lazygit
---- ----
[official documenation]: https://textual.textualize.io/guide/devtools/#console
[Textual]: https://textual.textualize.io/ [Textual]: https://textual.textualize.io/
[uv]: https://astral.sh/uv [uv]: https://astral.sh/uv
[just]: https://just.systems/ [just]: https://just.systems/
[prek]: https://prek.j178.dev/ [prek]: https://prek.j178.dev/
[ruff]: https://astral.sh/ruff [ruff]: https://astral.sh/ruff
[markdownlint-cli2]: https://github.com/DavidAnson/markdownlint-cli2 [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