You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specs2/build_and_deployment.md
+27Lines changed: 27 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -353,6 +353,33 @@ A per-repository working directory at `{repo_root}/.ac-dc/`. Created on first ru
353
353
354
354
This directory is **not** committed to the repository. The `.gitignore` entry is created automatically on first use.
355
355
356
+
## README.md Generation
357
+
358
+
The repository root contains a `README.md` that serves as a combined user guide and developer reference. Keep it as a single file with these sections in order:
359
+
360
+
1.**Title & tagline** — project name with lightning bolt, one-sentence description
361
+
2.**Philosophy** — speed-over-agency stance and the hybrid workflow (sprint → hit wall → agent → return)
362
+
3.**Features** — one bullet per capability, one sentence each, no elaboration
363
+
4.**Quick Start** — platform binaries from releases, `chmod`, run from git repo
364
+
5.**Configuration** — two subsections:
365
+
- LLM config with provider examples (Anthropic, OpenAI, Ollama, OpenAI-compatible local, Bedrock, Azure, Vertex) as copy-pasteable JSON blocks, plus a field reference table
366
+
- App config with defaults table
367
+
6.**Workflow** — numbered steps from task description through commit
368
+
7.**Keyboard Shortcuts** — table reflecting actual implementations:
369
+
-`chat-input.js``_onKeyDown`: Enter, Shift+Enter, Escape, ↑ at start, ↓ at end
- When shortcuts change in code, update the table to match
373
+
8.**Development** — prerequisites, setup, run modes table, CLI options table, test commands, tech stack with library links, project structure tree with one-line file descriptions
374
+
9.**License** — MIT
375
+
376
+
### Style rules
377
+
378
+
- One sentence per feature bullet — no multi-paragraph explanations
379
+
- Tables for all reference data (config fields, CLI options, shortcuts)
380
+
- Project structure tree must mirror actual file layout — update on file add/remove/rename
381
+
- No screenshots, videos, or embedded media in the markdown
0 commit comments