Skip to content

Commit 0e1c851

Browse files
authored
docs: align README install section with the landing page (#137)
* docs: align README install section with the landing page Lead with the install.sh one-liner (it also sets up the odek engine), note bodek upgrade, then Windows/manual releases, then source build. * docs: correct installer claims in the README install section The installer offers to install the odek engine (piped installs default to No; --with-odek to force) and prefers /usr/local/bin with a ~/.local/bin fallback.
1 parent e899aba commit 0e1c851

1 file changed

Lines changed: 12 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,26 +65,24 @@ bodek reuses that exact protocol from the terminal, which means:
6565

6666
## Install
6767

68-
**Prerequisite:** bodek is only the front-end — you also need the `odek`
69-
engine. See [odek's install instructions](https://github.com/BackendStack21/odek)
70-
(provider env key such as `DEEPSEEK_API_KEY` / `ZAI_API_KEY` — see odek's [PROVIDERS.md](https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md)).
71-
72-
### Prebuilt binaries
73-
74-
Download the latest compiled binary from the
75-
[releases page](https://github.com/BackendStack21/bodek/releases) — archives
76-
are published for Linux, macOS, and Windows (amd64 & arm64), with
77-
`checksums.txt` for verification.
78-
79-
One-liner for Linux / macOS (checksum-verified, installs into `~/.local/bin`):
80-
68+
One-liner for macOS & Linux (checksum-verified, installs into `/usr/local/bin`
69+
or `~/.local/bin` when that is not writable).
70+
It offers to set up the `odek` engine, which bodek needs on `PATH` (piped
71+
installs default to No — rerun with `--with-odek` to install it
72+
unconditionally):
8173

8274
```bash
8375
curl -fsSL https://bodek.21no.de/install.sh | sh
8476
```
8577

78+
You still need a provider API key for the engine (`DEEPSEEK_API_KEY` /
79+
`ZAI_API_KEY` — see odek's [PROVIDERS.md](https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md)
80+
and its [install instructions](https://github.com/BackendStack21/odek)).
81+
Later, `bodek upgrade` downloads and installs the latest release the same way.
82+
8683
On Windows, download the `windows_amd64` (or `arm64`) `.zip` from the
87-
releases page and put `bodek.exe` on your `PATH`.
84+
[releases page](https://github.com/BackendStack21/bodek/releases) and put
85+
`bodek.exe` on your `PATH`.
8886

8987
### From source
9088

0 commit comments

Comments
 (0)