# AGENTS.md

🔍 A Hex Editor for Reverse Engineers, Programmers and people who value their retinas when working at 3 AM.

## Setup

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

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `plugins/` 296 source files
- `lib/`     172 source files
- `main/`    26 source files
- `dist/`    14 source files
- `tests/`   11 source files
- `cmake/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `lib/libimhex/include/hex/test/test_provider.hpp`.
- CI defines what passing means. See `.github/workflows/analysis.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- Generated output is committed (`dist/`). Search will return the compiled copy, so edit the source, not that.
- `plugins/fonts/include/fonts/tabler_icons.hpp` is 287KB. 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.