# AGENTS.md

JSON for Modern C++

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
make run_benchmarks
make fuzz_testing
make fuzz_testing_bson
make fuzz_testing_cbor
make fuzz_testing_msgpack
make fuzz_testing_ubjson
```

## Layout

- `docs/`           249 source files
- `tests/`          204 source files
- `include/`        47 source files
- `tools/`          5 source files
- `single_include/` 2 source files
- `cmake/`          1 source file

## Conventions

- Tests live alongside the code they cover, following `tests/CMakeLists.txt`.
- CI defines what passing means. See `.github/workflows/check_amalgamation.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `single_include/nlohmann/json.hpp` is 1017KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.