# README.md

This is a starter README for a recomp project.

Replace the placeholder text with project-specific details.

## What This Is

Shortly explain:

- the game or system
- whether this is a framework repo or game repo
- what currently works
- what is still experimental

## Status

Current status:

- [ ] research
- [ ] tech demo
- [ ] experimental
- [ ] alpha
- [ ] playable alpha
- [ ] playable
- [ ] released

Be specific about what was tested. Do not imply a full playthrough unless one happened.

## Required Files

The user must provide their own legally obtained files.

This project does not provide game files or retail BIOS files.

Required:

- game file:
- BIOS or firmware file, if applicable:

## Build

```sh
# fill in build steps
```

## Run

```sh
# fill in run command
```

## Development Notes

- Generated code is build output.
- Do not edit generated files by hand.
- Check dispatch misses after running.
- Check coverage if the project reports it.
- Use the debug protocol documented in `TCP.md` or `TCP_COMMANDS.md`.

## Release Notes

Release packages should not include:

- game files
- retail BIOS files
- private saves
- dumps
- scratch captures
- local build junk