From 8fecee82dfc36f6ff4b10e7451aea5d8267061b0 Mon Sep 17 00:00:00 2001 From: thinkinginmath Date: Sat, 19 Sep 2026 10:41:59 +0000 Subject: [PATCH] README: lead the install with the one-line commands A learner sent here from a course page's run panel met a clone-and-venv recipe. Installation now starts with the macOS installer script and, for Linux or any machine with uv, `uv tool install --from agent-runtime` (checked: it installs and runs). The clone recipe stays, for working on the runtime. Co-Authored-By: Claude Opus 5 (1M context) --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e84c809..004f4bb 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,25 @@ This runtime is designed with user trust as a core principle: ### Installation +On macOS, one command. It uses [uv](https://docs.astral.sh/uv/) if you have it, which also brings +the right Python, or else Python 3.11 or newer; if neither is there, it says how to get one. Run it +again to upgrade. + +```bash +curl -fsSL https://raw.githubusercontent.com/SciMigo/agent-runtime/main/scripts/install-macos.sh | bash +``` + +On Linux, or anywhere with uv: + +```bash +uv tool install --from https://github.com/SciMigo/agent-runtime/archive/refs/heads/main.tar.gz agent-runtime +``` + +If your shell cannot find `agent-runtime` afterwards, run `uv tool update-shell` and open a new +terminal. Do not `pip install agent-runtime` from PyPI: that name belongs to an unrelated package. + +To work on the runtime itself, install it from a clone: + ```bash # Clone the repository git clone https://github.com/SciMigo/agent-runtime.git