Commit 291e724
committed
docs: install from the repo, since defib was never published to PyPI
README and the web UI's frame-blast fallback both tell people to run
`uv tool install defib` / `pipx install defib`. There is no `defib` on
PyPI — https://pypi.org/pypi/defib/json is a 404 — so both commands fail
for anyone who has not already got the tool some other way.
This is not theoretical. OpenIPC/firmware#2299 is a user recovering a
bricked hi3518ev200: a frame-blast chip, so the web UI sent them to
exactly the line above. They got defib working eventually, but when a
fix landed and they were asked to reinstall, the install went to a
different place than the copy on their PATH and they spent two rounds
reporting results from the old build against a bug that was already
fixed.
Point both at the git URL, and add the uvx one-liner — it needs no
install at all and cannot be shadowed by an active virtualenv, which is
what went wrong in that issue.
Publishing to PyPI would also close this and is worth doing; it needs a
maintainer with the account, so the docs fix goes first.1 parent 6a5c364 commit 291e724
2 files changed
Lines changed: 11 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| 16 | + | |
| 17 | + | |
16 | 18 | | |
17 | | - | |
| 19 | + | |
18 | 20 | | |
19 | | - | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
20 | 28 | | |
21 | 29 | | |
22 | 30 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
618 | 618 | | |
619 | 619 | | |
620 | 620 | | |
621 | | - | |
| 621 | + | |
622 | 622 | | |
623 | 623 | | |
624 | 624 | | |
| |||
0 commit comments