mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-17 04:45:33 -08:00
Add a Before you start block to the newcomer docs and a test to keep them in step
AI Assisted
This commit is contained in:
1 parent
b639c8945d
commit
3469a74cc1
12 files changed
+117
-25
No files matched your search
@@ -25,7 +25,7 @@ hand, or the reverse — the checkboxes are the only handoff.
|
||||
|
||||
```bash
|
||||
# From the plan2code root directory
|
||||
node install.js # A (everything + dev tools) — or C → O (loop only)
|
||||
node install.js # A → E (everything + dev tools) or A → O (loop only)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ One thing to remember: **collect after every finished spec.** Everything else is
|
||||
|
||||
```bash
|
||||
# Install once, from the plan2code root
|
||||
node install.js # A (everything + dev tools) — or C → M (metrics only)
|
||||
node install.js # A → E (everything + dev tools) or A → M (metrics only)
|
||||
|
||||
# After finishing a spec (steps 1–4)
|
||||
cd your-project
|
||||
|
||||
@@ -36,7 +36,7 @@ The icons down the left are Planny, the project mascot.
|
||||
## Install
|
||||
|
||||
```bash
|
||||
node install.js # A (everything + dev tools) — or C → S (status line only)
|
||||
node install.js # A → E (everything + dev tools) or A → S (status line only)
|
||||
```
|
||||
|
||||
That copies the script to `~/.claude/plan2code-statusline.js`, writes a default config to
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ Built for **maintainers**. If you're using Plan2Code to ship features, you don't
|
||||
## Install
|
||||
|
||||
```bash
|
||||
node install.js # A (everything + dev tools) — or C → B (bot only)
|
||||
node install.js # A → E (everything + dev tools) or A → B (bot only)
|
||||
```
|
||||
|
||||
## Run
|
||||
|
||||
@@ -7,6 +7,17 @@ Each session stays short, and the specs on disk carry everything from one sessio
|
||||
|
||||
---
|
||||
|
||||
## Before you start
|
||||
|
||||
- **Node.js 18 or newer.** Check with `node --version`. No Node? Get it from [nodejs.org](https://nodejs.org/) (the LTS download), or run `winget install OpenJS.NodeJS.LTS` on Windows, `brew install node` on macOS, or use `nvm` on Linux. Then open a new terminal.
|
||||
- **Start from your project.** Open your terminal in the project you want to work on (`cd` into it) before you run anything. Plan2Code works on the folder you start it in.
|
||||
- **Ways in.** `plan2code` (Claude Code, Devin or Codex), or type `/plan2code` in your agent (`$plan2code` in Codex).
|
||||
- **No agent yet?** Install Claude Code, Codex or Devin first.
|
||||
|
||||
Not installed yet? The install steps are in the [README](../README.md#install-and-start).
|
||||
|
||||
---
|
||||
|
||||
## Session 1: Plan
|
||||
|
||||
Run `plan2code` in the project (or `/plan2code` inside your agent). The dashboard opens in your
|
||||
|
||||
Reference in new issue
Block a user