Skip to content

Commit cd08ca9

Browse files
docs: adopt new README with corrected prerequisites
Replace README with the centered-header draft. Fix prerequisites to require Docker + Docker Compose (Postgres, Redis, minio run in containers) with Node.js 20+ and Python 3.11+, matching docs/running.md, and add minio to the architecture list. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent b16d155 commit cd08ca9

1 file changed

Lines changed: 120 additions & 121 deletions

File tree

README.md

Lines changed: 120 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,188 +1,187 @@
1-
# QuantumByte
1+
<p align="center">
2+
<img src="apps/web/public/logo_qbits_color.png" width="180" alt="QuantumByte" />
3+
</p>
24

3-
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
4-
[![Discord](https://img.shields.io/badge/Discord-join%20the%20community-5865F2?logo=discord&logoColor=white)](https://discord.gg/zFD35kwHmU)
5+
<h1 align="center">Vibe coding is just the beginning.</h1>
56

6-
> **The first open-source Convergence App Builder.**
7+
<p align="center">
8+
The open-source Convergence App Builder.<br />
9+
Generate a working app from intent, then verify every agent turn against its business requirements.
10+
</p>
711

8-
Generate working service-automation apps from intent, then continuously verify what the AI built against the app's business requirements.
12+
<p align="center">
13+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="Apache 2.0 license" /></a>
14+
<a href="https://discord.gg/zFD35kwHmU"><img src="https://img.shields.io/badge/Discord-join%20the%20founding%20group-5865F2?logo=discord&logoColor=white" alt="Join the founding group on Discord" /></a>
15+
<img src="https://img.shields.io/badge/status-public%20alpha-f59e0b" alt="Public alpha" />
16+
</p>
917

10-
**The model generates. The harness verifies. Humans decide when it is ready to ship.**
18+
<p align="center">
19+
<a href="#quickstart">Quickstart</a> ·
20+
<a href="#why-convergence">Why convergence</a> ·
21+
<a href="#how-the-harness-works">The harness</a> ·
22+
<a href="https://discord.gg/zFD35kwHmU">Contribute</a>
23+
</p>
1124

12-
## Why QuantumByte exists
25+
> **The model generates. The harness verifies. Humans decide when it is ready.**
1326
14-
AI can produce software that looks finished long before it is actually ready.
27+
QuantumByte is early, working, and intentionally being built in public. We are looking for founding contributors who believe software should be shaped by the people who understand the problem, not only by the people who can code.
1528

16-
The interface may render. The happy path may work. The demo may impress. Yet important requirements can still be missing, misunderstood, or silently broken. We call this **false convergence**.
29+
**[Join the founding group on Discord](https://discord.gg/zFD35kwHmU)**
1730

18-
QuantumByte approaches AI-assisted software development as a continuing loop:
31+
## Why convergence
1932

20-
```text
21-
Intent -> Build -> Inspect -> Verify -> Repair -> Decide
22-
```
23-
24-
It does not treat generated code as the final answer. After every agent turn, QuantumByte's built-in requirements harness checks the current app and returns structured verdicts with evidence.
33+
Vibe coding made software creation accessible. That is the breakthrough.
2534

26-
**Vibe coding ends at the demo. Convergence starts with evidence.**
27-
28-
## What ships today
35+
But an app can look finished long before it is ready for real operations. The interface renders. The happy path works. The demo impresses. Important requirements can still be missing, misunderstood, or silently broken.
2936

30-
QuantumByte is a working, open-source app builder engine with an integrated business-requirements harness.
37+
We call this **false convergence**.
3138

32-
### App generation
39+
Generation gets you to an app that builds. Convergence asks what comes next:
3340

34-
- Capture the product intent through a conversational workspace.
35-
- Generate and update a working application in a dedicated project repository.
36-
- Keep every completed agent turn in a buildable state.
37-
- Preview the app live with health checks and device frames.
38-
- Coordinate multiple workers with project-to-worker affinity and turn recovery.
41+
- Does the app still match the original intent?
42+
- Are its critical business requirements satisfied?
43+
- What evidence supports each verdict?
44+
- What must be repaired before humans trust it?
3945

40-
### Continuous requirements verification
41-
42-
- Derive business requirements from the product overview.
43-
- Let users add or lock requirements that must remain authoritative.
44-
- Audit every requirement independently using a read-only verifier.
45-
- Return structured `SUCCESS` or `FAIL` verdicts with supporting evidence.
46-
- Record inconclusive runs separately instead of turning uncertainty into a false failure.
47-
- Re-check only requirements affected by relevant code changes.
48-
- Run verification in the background without blocking the next conversation.
49-
- Show live requirement status in the product workspace.
50-
51-
## How it works
46+
QuantumByte turns app generation into a continuing loop:
5247

5348
```text
54-
User intent
55-
|
56-
v
57-
Main agent -> product overview -> engineer agent -> working app
58-
|
59-
v
60-
requirements harness
61-
|
62-
+--------------------+--------------------+
63-
| | |
64-
verdict evidence watched files
65-
| | |
66-
+--------------------+--------------------+
67-
|
68-
v
69-
repair or ship decision
49+
Intent -> Build -> Verify -> Evidence -> Repair or Ready
7050
```
7151

72-
The builder and verifier are deliberately separated. The builder can edit the project. The harness is read-only and evaluates one business requirement at a time, without inheriting the builder's conversational context.
73-
74-
## Convergence Programming
52+
The current open-source release begins with explicit business requirements. After every agent turn, a separate read-only harness checks the app requirement by requirement and returns structured verdicts with evidence.
7553

76-
QuantumByte is an early executable system inspired by **Convergence Programming**, a research framework for AI-assisted programming and agents.
54+
## What ships today
7755

78-
Traditional software generation is often framed as:
56+
### App builder
7957

80-
```text
81-
specification -> program
82-
```
58+
- Conversational intent capture and product overview
59+
- Agent-generated applications in dedicated project repositories
60+
- Build recovery after every completed agent turn
61+
- Live app previews with health checks and device frames
62+
- Worker coordination with project affinity and turn recovery
8363

84-
Convergence Programming studies the larger trajectory:
64+
### Requirements harness
8565

86-
```text
87-
lossy intent
88-
-> generated behavior
89-
-> observation
90-
-> evidence
91-
-> repair
92-
-> readiness decision
93-
-> action or block
94-
```
66+
- Requirements derived from the product overview
67+
- User-locked requirements that remain authoritative
68+
- Independent, read-only audits for every requirement
69+
- Structured `SUCCESS` or `FAIL` verdicts with evidence
70+
- `INCONCLUSIVE` recorded separately from genuine failure
71+
- Diff-scoped re-verification when relevant files change
72+
- Non-blocking background runs with live verdicts in the UI
9573

96-
The central research problem is false convergence: a system appears ready under visible review while important operational constraints remain undiscovered or unsatisfied.
74+
## Quickstart
9775

98-
The current open-source harness implements an initial part of that agenda: continuous verification of generated software against explicit business requirements. It does not yet claim full world-grounded verification, complete production readiness, or the proposed ConvergenceBench evaluation framework.
76+
### Prerequisites
9977

100-
## Who this is for
78+
- Docker and Docker Compose (Postgres, Redis, and minio run in containers)
79+
- Node.js 20+ and npm
80+
- Python 3.11+
81+
- An Anthropic API key for the current worker implementation
10182

102-
### Programmers
83+
### Run locally
10384

104-
Study, run, modify, and extend a real AI app-building system. Build from intent, verify against requirements, and inspect the evidence behind every verdict.
85+
```bash
86+
git clone https://github.com/QuantumByteOSS/quantumbyte.git
87+
cd quantumbyte
10588

106-
### Researchers
89+
make install
90+
make db-up
91+
make migrate
92+
make dev
93+
```
10794

108-
Use QuantumByte as an evolving reference implementation for studying false convergence, requirements preservation, verifier-centric agents, evidence collection, and readiness decisions in AI-generated software.
95+
Open [http://localhost:3000](http://localhost:3000). Run `make help` to see all development commands.
10996

110-
### Operators and internal builders
97+
For environment variables, service topology, and troubleshooting, read [docs/running.md](docs/running.md).
11198

112-
Turn a real workflow into an application while keeping the business requirements visible and continuously checked throughout the build.
99+
## How the harness works
113100

114-
## Architecture
101+
```text
102+
User intent
103+
|
104+
v
105+
Product overview -> Builder agent -> Working app
106+
|
107+
v
108+
Read-only harness
109+
|
110+
+------------------+------------------+
111+
| | |
112+
Verdict Evidence Watched files
113+
| | |
114+
+------------------+------------------+
115+
|
116+
v
117+
Repair or ready
118+
```
115119

116-
| Component | Role | Current stack |
117-
| ------------------- | ---------------------------------------------------------------------------------- | --------------------------- |
118-
| `apps/web` | Product workspace, chat, live preview, requirements UI | Next.js, TypeScript, Prisma |
119-
| `apps/orchestrator` | Project assignment, worker coordination, recovery | Python, PostgreSQL |
120-
| `apps/worker` | Agent execution, workspace management, build loop, verification harness | Python, Claude Agent SDK |
121-
| PostgreSQL | Shared source of truth for projects, messages, workers, requirements, and verdicts | PostgreSQL |
122-
| Redis | Per-project harness locking | Redis |
120+
The builder and verifier are deliberately separated. The builder can edit the project. The harness evaluates one business requirement at a time without inheriting the builder's conversation, and it cannot modify the repository it is auditing.
123121

124-
The current worker uses the Claude Agent SDK. A provider-neutral agent boundary and additional model providers are on the roadmap.
122+
## Architecture
125123

126-
See [ARCHITECTURE.md](ARCHITECTURE.md) for the system overview and [docs/running.md](docs/running.md) for the complete local setup.
124+
- **`apps/web`**: workspace, chat, live preview, and requirements UI using Next.js, TypeScript, and Prisma
125+
- **`apps/orchestrator`**: project assignment, worker coordination, and recovery using Python and PostgreSQL
126+
- **`apps/worker`**: agent execution, build loop, workspace management, and requirements harness using Python and the Claude Agent SDK
127+
- **PostgreSQL**: source of truth for projects, messages, workers, requirements, and verdicts
128+
- **Redis**: per-project harness locking
129+
- **minio**: S3-compatible store for agent-generated assets
127130

128-
## Getting started
131+
The current worker uses the Claude Agent SDK. Provider-neutral agent boundaries and additional model providers are on the roadmap.
129132

130-
### Prerequisites
133+
See [ARCHITECTURE.md](ARCHITECTURE.md) for the system overview.
131134

132-
- Node.js and npm
133-
- Python 3
134-
- PostgreSQL
135-
- Redis
136-
- An Anthropic API key for the current worker implementation
135+
## Convergence Programming
137136

138-
### Run locally
137+
QuantumByte is an early executable system inspired by **Convergence Programming**, a research framework for AI-assisted programming and agents.
139138

140-
```bash
141-
git clone https://github.com/QuantumByteOSS/quantumbyte.git
142-
cd quantumbyte
139+
Traditional software generation is often framed as `specification -> program`. Convergence Programming studies the larger trajectory:
143140

144-
make install
145-
make db-up
146-
make migrate
147-
make dev
141+
```text
142+
lossy intent
143+
-> generated behavior
144+
-> observation
145+
-> evidence
146+
-> repair
147+
-> readiness decision
148+
-> action or block
148149
```
149150

150-
The web app runs at [http://localhost:3000](http://localhost:3000). Run `make help` to see the available development commands.
151-
152-
For environment variables, service topology, and troubleshooting, read [docs/running.md](docs/running.md).
151+
The current harness implements one part of that agenda: continuous verification of generated software against explicit business requirements. It does not yet claim full world-grounded verification, complete production readiness, or the proposed ConvergenceBench evaluation framework.
153152

154153
## Roadmap
155154

156155
- [x] Intent-to-app generation
157-
- [x] Live application preview and health checks
156+
- [x] Live previews and health checks
158157
- [x] Continuous business-requirements harness
159-
- [x] Structured per-requirement verdicts and evidence
158+
- [x] Per-requirement verdicts and evidence
160159
- [ ] One-command self-hosting
161160
- [ ] Model and agent provider adapters
162-
- [ ] Concept editor
163-
- [ ] Live code editor
164-
- [ ] Visual blueprint editor
161+
- [ ] Concept, code, and blueprint editors
165162
- [ ] World-grounded evidence and readiness gates
166163
- [ ] ConvergenceBench reference tasks and evaluation tooling
167164

168165
See [docs/roadmap.md](docs/roadmap.md) for milestone details.
169166

170167
## Why open source
171168

172-
The AI app-generation layer is commoditizing. Generating more code is not the durable problem.
169+
The AI app-generation layer is commoditizing. We would rather help it happen than pretend otherwise.
173170

174-
The harder problem is keeping human intent, AI interpretation, generated behavior, and operational requirements aligned as the system changes.
171+
Generating more code is not the durable problem. The harder problem is keeping human intent, AI interpretation, generated behavior, and operational requirements aligned as the system changes.
175172

176-
We are open-sourcing the engine so programmers and researchers can inspect the harness, challenge its assumptions, reproduce its behavior, and help build better ways to determine when AI-generated software is actually ready.
173+
We are opening the engine so programmers and researchers can inspect the harness, challenge its assumptions, reproduce its behavior, and help build better ways to decide when AI-generated software is actually ready.
177174

178175
## Contributing
179176

180-
Read [CONTRIBUTING.md](CONTRIBUTING.md) before opening a contribution. All participation is governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
177+
The first contributor group is intentionally small. We are looking for engineers with taste, first-principles thinkers who still ship, and researchers interested in requirements, verification, agents, and human-AI collaboration.
178+
179+
1. **[Join the Discord](https://discord.gg/zFD35kwHmU)** and introduce yourself.
180+
2. Read [CONTRIBUTING.md](CONTRIBUTING.md).
181+
3. Review [docs/roadmap.md](docs/roadmap.md) and propose where you can help.
181182

182-
- Join the [QuantumByte Discord](https://discord.gg/zFD35kwHmU)
183-
- Follow or DM [@kevin.pantasdo](https://www.threads.com/@kevin.pantasdo)
184-
- Report security issues according to [SECURITY.md](SECURITY.md)
183+
All participation is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). Report security issues according to [SECURITY.md](SECURITY.md).
185184

186185
## License
187186

188-
QuantumByte is licensed under [Apache License 2.0](LICENSE).
187+
QuantumByte is licensed under the [Apache License 2.0](LICENSE).

0 commit comments

Comments
 (0)