Skip to content

Commit 26cb5c8

Browse files
DocAtPromptclaude
andcommitted
README: real install instructions from the repo, not PyPI
The install section promised 'uvx ctrlgrid' / 'pip install ctrlgrid', which do nothing until the package is on PyPI — and it isn't. Replace them with the commands that actually work today, from the public repository: uvx --from git+…, uv tool install git+…, pip install git+…, and the clone + uv sync dev setup. All verified by running uvx from the repo (build, --help, and a real preset generation with the bundled font). Python 3.11+. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 7d98e39 commit 26cb5c8

1 file changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ e-ink tablets.
4242
>
4343
> Not yet: `--skip-unsupported`.
4444
>
45-
> **Not on PyPI yet**, so the `uvx`/`pip` lines below do not work until the
46-
> first release is published.
45+
> **Not on PyPI yet** — install straight from this repository (see below).
4746
4847
## The one promise
4948
@@ -80,12 +79,35 @@ ctrlgrid
8079
8180
## Installation
8281

82+
Not on PyPI yet, so install straight from this repository. With
83+
[uv](https://docs.astral.sh/uv/):
84+
85+
```bash
86+
# run it once, without installing anything
87+
uvx --from git+https://github.com/DocAtPrompt/ctrlgrid.git ctrlgrid --help
88+
89+
# or install it as a tool on your PATH
90+
uv tool install git+https://github.com/DocAtPrompt/ctrlgrid.git
91+
ctrlgrid --help
92+
```
93+
94+
Or with pip, into an environment of your choosing:
95+
96+
```bash
97+
pip install git+https://github.com/DocAtPrompt/ctrlgrid.git
98+
```
99+
100+
To work on it, clone and let uv build the environment:
101+
83102
```bash
84-
uvx ctrlgrid --help # no installation
85-
pip install ctrlgrid # or the usual way
103+
git clone https://github.com/DocAtPrompt/ctrlgrid.git
104+
cd ctrlgrid
105+
uv sync --extra dev
106+
uv run ctrlgrid --help
86107
```
87108

88-
There are no double-clickable installers, and none are planned.
109+
Python 3.11 or newer. There are no double-clickable installers, and none are
110+
planned.
89111

90112
## What it generates
91113

0 commit comments

Comments
 (0)