From eb18ec703fec7ee7173fb03654fd701a811d5b82 Mon Sep 17 00:00:00 2001 From: "Agent (OpenClaw)" Date: Thu, 5 Mar 2026 19:17:25 +0100 Subject: [PATCH] Agent: Add a Local development section to README and keep CI green. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 4661e54..a0bcc6e 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,36 @@ If Homebrew is unavailable: More CLI details: [docs/cli.md](docs/cli.md) Full installation guide: [docs/installation.md](docs/installation.md) +## Local development + +Prerequisites: +- Rust stable toolchain (`rustup toolchain install stable`) +- A C/C++ toolchain available in `PATH` + +Build and run from this repo: + +```bash +cargo build --all +cargo run -p floe-cli -- --help +``` + +Run checks before opening a PR: + +```bash +cargo fmt --all -- --check +cargo clippy --workspace --all-targets -- -D warnings +``` + +Run tests: + +```bash +cargo test -p floe-core --test unit +cargo test -p floe-core --test integration +cargo test -p floe-cli --tests +``` + +For orchestrators (Dagster + Airflow) local setup, see [orchestrators/LOCAL_DEV.md](orchestrators/LOCAL_DEV.md). + ## Run with Docker ### Pull