# AGENTS.md

The Serenity Operating System 🐞

## 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

- `Userland/` 6562 source files
- `Kernel/`   1188 source files
- `Tests/`    413 source files
- `Ports/`    375 source files
- `AK/`       243 source files
- `Meta/`     200 source files

## Conventions

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

## Gotchas

- `Userland/Libraries/LibWeb/CSS/Parser/Parser.cpp` is 393KB. 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.