From a166a6af2974c24ddcee2e9d46361bd2e73cf9c6 Mon Sep 17 00:00:00 2001 From: Isaiah Odhner Date: Thu, 8 Jun 2023 03:09:56 -0400 Subject: [PATCH] Note how to install CLI for development --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 95e544b..f65ca5b 100644 --- a/README.md +++ b/README.md @@ -219,6 +219,16 @@ Or run more basically: python -m src.textual_paint.paint ``` +Or install the CLI globally: +```bash +pip install --editable . +``` + +Then run: +```bash +textual-paint +``` + `--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.