From 0eff954a4fd29cefde5cf73ad913cd4f09950453 Mon Sep 17 00:00:00 2001 From: bendtherules Date: Tue, 14 Apr 2026 17:50:10 +0530 Subject: [PATCH] docs: replace Setup section with Development guide Removed the outdated Setup documentation and introduced a new Development section that includes cloning instructions, spec setup steps, and guidance on building the knowledge graph for custom ECMAScript specifications. This reorganization clarifies the workflow for developers and users building the project from source. --- Readme.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/Readme.md b/Readme.md index 9e1bbf5..f94bd95 100644 --- a/Readme.md +++ b/Readme.md @@ -33,18 +33,6 @@ cd ask262 bun install ``` -## Setup - -1. **Ensure spec is present** (only external requirement): - - `./spec-built/multipage/` - ECMAScript spec HTML files - - *Note: `storage/` (pre-built vectors), `engine262/lib/`, and `graphology/` are included in the package.* - -2. **Build knowledge graph** (first time only, if using custom spec): - ```bash - bun run build - ``` - ## MCP Configuration Add to your MCP client configuration using `bunx` (no installation required): @@ -94,6 +82,25 @@ bun run test-evaluate-timeout bun run test-search-spec-sections ``` +## Development + +For development or using a custom ECMAScript specification: + +1. **Clone and setup**: + ```bash + git clone https://github.com/bendtherules/ask262 + cd ask262 + bun install + ``` + +2. **Ensure spec is present**: + - `./spec-built/multipage/` - ECMAScript spec HTML files + +3. **Build knowledge graph** (if using custom spec): + ```bash + bun run build + ``` + ## License ISC