docs: fiddle with README; just add "just" everywhere
All checks were successful
ci/woodpecker/push/workflow Pipeline was successful
All checks were successful
ci/woodpecker/push/workflow Pipeline was successful
This commit is contained in:
parent
9e92e0fe71
commit
1a5d552cfc
1 changed files with 9 additions and 4 deletions
13
README.md
13
README.md
|
|
@ -3,12 +3,14 @@
|
|||
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.
|
||||
It is not yet usable. It has tests.
|
||||
|
||||
## Running tests
|
||||
|
||||
```sh
|
||||
uv run pytest tests.py
|
||||
# or if you have just
|
||||
just test
|
||||
```
|
||||
|
||||
## Observing the app's console
|
||||
|
|
@ -25,15 +27,18 @@ Since we use uv, the incantation is a bit different from the [official documenat
|
|||
|
||||
In one terminal:
|
||||
|
||||
```shell
|
||||
```sh
|
||||
uv run textual console
|
||||
# or if you have just
|
||||
just console
|
||||
```
|
||||
|
||||
And in the other:
|
||||
|
||||
```shell
|
||||
# run,textual,run! ;)
|
||||
```sh
|
||||
uv run textual run --dev src/teilchensammler_cli/__init__.py
|
||||
# or if you have just
|
||||
just run-console
|
||||
```
|
||||
|
||||
## Developing
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue