From 4ae969e9cc03f8c0b5605339d1f9c3ec7da2d10d Mon Sep 17 00:00:00 2001 From: Rolando Santamaria Maso Date: Sun, 27 Sep 2026 12:55:23 +0200 Subject: [PATCH 1/2] 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. --- README.md | 23 +++++++++-------------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 821cef0..89130ed 100644 --- a/README.md +++ b/README.md @@ -65,26 +65,21 @@ bodek reuses that exact protocol from the terminal, which means: ## Install -**Prerequisite:** bodek is only the front-end — you also need the `odek` -engine. See [odek's install instructions](https://github.com/BackendStack21/odek) -(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)). - -### Prebuilt binaries - -Download the latest compiled binary from the -[releases page](https://github.com/BackendStack21/bodek/releases) — archives -are published for Linux, macOS, and Windows (amd64 & arm64), with -`checksums.txt` for verification. - -One-liner for Linux / macOS (checksum-verified, installs into `~/.local/bin`): - +One-liner for macOS & Linux (checksum-verified, installs into `~/.local/bin`). +It also sets up the `odek` engine, which bodek needs on `PATH`: ```bash curl -fsSL https://bodek.21no.de/install.sh | sh ``` +You still need a provider API key for the engine (`DEEPSEEK_API_KEY` / +`ZAI_API_KEY` — see odek's [PROVIDERS.md](https://github.com/BackendStack21/odek/blob/main/docs/PROVIDERS.md) +and its [install instructions](https://github.com/BackendStack21/odek)). +Later, `bodek upgrade` downloads and installs the latest release the same way. + On Windows, download the `windows_amd64` (or `arm64`) `.zip` from the -releases page and put `bodek.exe` on your `PATH`. +[releases page](https://github.com/BackendStack21/bodek/releases) and put +`bodek.exe` on your `PATH`. ### From source From 40068462326563e702da0eb1a885599e5c2064af Mon Sep 17 00:00:00 2001 From: Rolando Santamaria Maso Date: Sun, 27 Sep 2026 13:13:46 +0200 Subject: [PATCH 2/2] 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. --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89130ed..972d3eb 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,11 @@ bodek reuses that exact protocol from the terminal, which means: ## Install -One-liner for macOS & Linux (checksum-verified, installs into `~/.local/bin`). -It also sets up the `odek` engine, which bodek needs on `PATH`: +One-liner for macOS & Linux (checksum-verified, installs into `/usr/local/bin` +or `~/.local/bin` when that is not writable). +It offers to set up the `odek` engine, which bodek needs on `PATH` (piped +installs default to No — rerun with `--with-odek` to install it +unconditionally): ```bash curl -fsSL https://bodek.21no.de/install.sh | sh