docs: update readme
This commit is contained in:
12
README.md
12
README.md
@@ -21,16 +21,14 @@ Also:
|
|||||||
|
|
||||||
## How to run
|
## How to run
|
||||||
|
|
||||||
Install the dependencies with:
|
This project uses [uv](https://github.com/astral-sh/uv) for dependency management.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ virtualenv venv && source venv/bin/activate && pip install -r requirements.txt
|
# install dependencies (creates .venv)
|
||||||
```
|
$ uv sync
|
||||||
|
|
||||||
Run the main application with:
|
# run the TUI
|
||||||
|
$ uv run main.py
|
||||||
```bash
|
|
||||||
$ python main.py
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
|
|||||||
Reference in New Issue
Block a user