diff --git a/README.md b/README.md index f65ca5b..2a1008d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/cspell.json b/cspell.json index 5543beb..34b1fc9 100644 --- a/cspell.json +++ b/cspell.json @@ -102,6 +102,7 @@ "undoable", "undos", "ustom", + "venv", "vkey", "webp", "webstorm",