From 3b629745621c7cc54d02a28fbc4a68055a75da52 Mon Sep 17 00:00:00 2001 From: Amish Regmi Date: Fri, 15 May 2026 18:37:47 -0400 Subject: [PATCH] docs(README): add Ninja + ripgrep to the "Contributing from source" prereqs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The short prereqs list in README.md hasn't been kept in sync with CONTRIBUTING.md's expanded prerequisites table: - Ninja was added to CONTRIBUTING.md in #1783 (required on macOS for the CEF helper compile). - ripgrep is being added to CONTRIBUTING.md in #1867 (required by the `lint:commands-tokens` pre-push step). Add both to README.md's bullet 1 so contributors who read only the README still get the full tool list. "Platform desktop build prerequisites" continues to cover the macOS-specific x86_64 target and codesign script — those are spelled out in the deeper CONTRIBUTING.md doc that this README section already points at. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c65d8e8755..71701932a1 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ OpenHuman is an open-source agentic assistant designed to integrate with you in New contributor? Start with [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the fork/PR workflow and local validation commands. The short path is: -1. Install Git, Node.js 24+, pnpm 10.10.0, Rust 1.93.0 (`rustfmt` + `clippy`), CMake, and the platform desktop build prerequisites. +1. Install Git, Node.js 24+, pnpm 10.10.0, Rust 1.93.0 (`rustfmt` + `clippy`), CMake, Ninja, ripgrep, and the platform desktop build prerequisites. 2. Fork and clone the repo, then run `git submodule update --init --recursive` before `pnpm install` so the vendored Tauri/CEF sources are present. 3. Use `pnpm dev` for web-only UI work, `pnpm --filter openhuman-app dev:app` for the desktop shell, and focused checks such as `pnpm typecheck`, `pnpm format:check`, and `cargo check -p openhuman --lib` before opening a PR.