Skip to content

Commit 6c81034

Browse files
Brandon McCallcursoragent
authored andcommitted
docs: drop contracts/lib layout explainer from README
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 248fd0f commit 6c81034

1 file changed

Lines changed: 0 additions & 16 deletions

File tree

README.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ This repository contains the **protocol specification**, a **working dev skeleto
1616
- [Why this project](#why-this-project)
1717
- [Current status](#current-status)
1818
- [Repository layout](#repository-layout)
19-
- [Understanding `contracts/` (no “lib2” folders)](#understanding-contracts-no-lib2-folders)
2019
- [Quickstart](#quickstart)
2120
- [Scripts & quality gates](#scripts--quality-gates)
2221
- [Project board and issues (maintainers)](#project-board-and-issues-maintainers)
@@ -63,18 +62,6 @@ Treat on-chain code as **templates to extend**, not audited production assets.
6362

6463
---
6564

66-
## Understanding `contracts/` (no “lib2” folders)
67-
68-
Foundry uses a standard triad at the **project root** (`contracts/`):
69-
70-
- **`src/`***your* protocol contracts (`IntentSettler.sol`, `SolverAuction.sol`, interfaces, libraries).
71-
- **`test/`***your* Foundry tests.
72-
- **`lib/`****third-party dependencies** (here: **`forge-std`**, the testing/stdlib package from [Foundry](https://github.com/foundry-rs/forge-std)).
73-
74-
Because **`forge-std` is itself a Foundry project**, you will see **`lib/forge-std/src/`** and **`lib/forge-std/test/`** inside the dependency. That is normal: it is **not** a duplicate “src2” layer — it is the dependency’s own source tree, nested under `lib/`.
75-
76-
---
77-
7865
## Quickstart
7966

8067
**Prerequisites:** Node.js **18+**, **Docker**, **Foundry** (`forge`, `anvil`).
@@ -161,8 +148,5 @@ Distributed under the [MIT License](LICENSE).
161148
**Are the smart contracts “done”?**
162149
No. They are **intentional templates**: interfaces, structs, events, and stub logic so the repo builds and tests run. Escrow, messaging, auctions, and economic security must be implemented and reviewed before any deployment.
163150

164-
**What if I see paths like `lib/.../src/` — is that `src2`?**
165-
No. Only **`contracts/src`** is your protocol source. Nested `src` under **`contracts/lib/*`** belongs to **dependencies** (e.g. forge-std).
166-
167151
**Who maintains this?**
168152
Project founder: **[@sp0oby](https://github.com/sp0oby)**. Contributors welcome per [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)