Skip to content

docs: add quick Windows demo and test instructions (attrs note) #3870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add quick Windows demo and test instructions (attrs note) #3870

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,3 +437,27 @@ See also [Rich CLI](https://github.com/textualize/rich-cli) for a command line a
See also Rich's sister project, [Textual](https://github.com/Textualize/textual), which you can use to build sophisticated User Interfaces in the terminal.

![textual-splash](https://github.com/user-attachments/assets/4caeb77e-48c0-4cf7-b14d-c53ded855ffd)

### Quick Demo (Windows PowerShell)

```powershell
python -m venv .venv
. .\.venv\Scripts\Activate.ps1
pip install -U pip
pip install -e .
python - << "PY"
from rich import print
from rich.table import Table
print("[bold green]Rich works![/]")
t = Table(title="Sample Results"); t.add_column("Name"); t.add_column("Score", justify="right")
t.add_row("Alpha","92"); t.add_row("Beta","87"); t.add_row("Gamma","95")
print(t)
PY

**“Run Tests (dev setup)”**
```md
### Run Tests (dev setup)

```bash
pip install pytest attrs
pytest -q