Skip to content

Commit 0655fa2

Browse files
committed
feat: update-readme-bun-requirement - add Requirements section
1 parent 1220416 commit 0655fa2

3 files changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ The primary responsibility of this harness is to **reduce context bloat** by dig
1414

1515
The harness consists of a simple for-loop, executing a new coding agent with a mandate from `PROMPT.md` to complete a *single* task from `TASKS.md`, while reading and recording any insight gained during the work into `LEARNINGS.md`.
1616

17+
## Requirements
18+
19+
**[Bun](https://bun.sh) is required** to run this tool. Node.js is not supported.
20+
21+
```bash
22+
# Install Bun (macOS, Linux, WSL)
23+
curl -fsSL https://bun.sh/install | bash
24+
```
25+
26+
Why Bun?
27+
- This tool is written in TypeScript and uses Bun's native TypeScript execution (no compilation step)
28+
- The CLI uses a `#!/usr/bin/env bun` shebang for direct execution
29+
- Bun's speed makes the agent loop faster and more responsive
30+
1731
## Installation
1832

1933
### From npm (recommended)

todo/LEARNINGS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,11 @@ Use this knowledge to avoid repeating mistakes and build on what works.
6363
- Kept `bunx` as the recommended method for one-off usage since it doesn't require global installation
6464
- Documentation-only changes don't require tests - verified existing tests still pass (with same pre-existing failure)
6565
- Pre-existing test failure (1 fail, 86 pass) confirmed to exist before changes via git stash verification
66+
67+
## update-readme-bun-requirement
68+
69+
- Placed the Requirements section between "Core Concept" and "Installation" - logical flow for users (understand tool -> check requirements -> install)
70+
- Used bold markdown + inline link for emphasis: `**[Bun](https://bun.sh) is required**` draws attention while making it easy to find install instructions
71+
- Included the one-liner install command since most users will need it - reduces friction
72+
- Listed three concrete reasons why Bun is needed: native TypeScript execution, shebang support, and speed
73+
- Pre-existing test failure (1 fail, 86 pass) still present - confirmed via git stash that it predates this change

todo/TASKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Each agent picks the next pending task, implements it, and marks it complete.
7575
### update-readme-bun-requirement
7676

7777
- content: Add a prominent "Requirements" section near the top of README.md stating that Bun is required to run this tool (not Node.js). Link to bun.sh for installation instructions. Explain why Bun is needed (TypeScript execution, shebang).
78-
- status: pending
78+
- status: complete
7979
- dependencies: update-readme-installation
8080

8181
---

0 commit comments

Comments
 (0)