Skip to content

Commit c8f19c7

Browse files
dfa1claude
andcommitted
docs: collapse Development section into Contributing in README
Build commands lived in both README and CONTRIBUTING.md. Removed the duplicate Development section; CONTRIBUTING.md is now the single source of truth for build reference. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 3ac3484 commit c8f19c7

1 file changed

Lines changed: 3 additions & 25 deletions

File tree

README.md

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -64,33 +64,11 @@ Docs follow the [Diátaxis](https://diataxis.fr/) framework.
6464
| [docs/compatibility.md](docs/compatibility.md) | Reference | Encoding support table, S3 fixture status |
6565
| [docs/explanation.md](docs/explanation.md) | Explanation | Design rationale, memory model, testing strategy, benchmarks |
6666

67-
## Development
68-
69-
**Requirements:** Java 25+
70-
71-
Generated sources (`fbs`/`proto` → Java) are committed. Normal builds need no external tools.
72-
73-
```bash
74-
./mvnw verify # build + tests
75-
./mvnw verify -DskipTests
76-
77-
# run integration tests
78-
./mvnw verify -pl integration -am
79-
80-
# benchmarks (always pass ClassName.methodName filter)
81-
./bench RustVsJavaReadBenchmark.javaReadVolume
82-
```
83-
84-
To regenerate schemas after editing `.fbs`/`.proto`:
85-
86-
```bash
87-
brew install flatbuffers protobuf
88-
./mvnw generate-sources -pl core -P regenerate-sources
89-
```
90-
9167
## Contributing
9268

93-
Forks and contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup,
69+
**Requirements:** Java 25+. Build: `./mvnw verify`.
70+
71+
Forks welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for full build reference,
9472
coding conventions, and how to add a new encoding.
9573

9674
This project uses [Claude Code](https://claude.ai/code) for implementation work.

0 commit comments

Comments
 (0)