Note about virtual environments

This commit is contained in:
Isaiah Odhner 2023-06-08 03:12:58 -04:00
parent a166a6af29
commit b1951cb555
2 changed files with 10 additions and 1 deletions

View File

@ -204,6 +204,12 @@ The program has only been tested on Linux. Issues on other platforms are as-yet
## Development
Recommended: create a virtual environment:
```bash
python -m venv .venv
source .venv/bin/activate
```
Install Textual and other dependencies:
```bash
pip install "textual[dev]" stransi psutil watchdog pyperclip pyright
@ -219,7 +225,7 @@ Or run more basically:
python -m src.textual_paint.paint
```
Or install the CLI globally:
Or install the CLI globally\*:
```bash
pip install --editable .
```
@ -229,6 +235,8 @@ Then run:
textual-paint
```
\*If you use a virtual environment, it will only install within that environment.
`--clear-screen` is useful for development, because it's sometimes jarring to see error messages that have actually been fixed, when exiting the program.
`--inspect-layout` lets you middle click to visualize the layout breakdown by labeling each widget in the hierarchy, and coloring their regions. The labels affect the layout, so you can also hold Ctrl to only colorize, and you can remember how the colors correspond to the labels, to build a mental model of the layout.

View File

@ -102,6 +102,7 @@
"undoable",
"undos",
"ustom",
"venv",
"vkey",
"webp",
"webstorm",