# AGENTS.md

This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.

## Setup

```
cargo build
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `src/`              76 source files
- `tests/`            11 source files
- `mdbook-course/`    9 source files
- `third_party/`      7 source files
- `theme/`            4 source files
- `mdbook-exerciser/` 2 source files

## Conventions

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

---

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.