# AGENTS.md

Open-source, self-hosted note-taking tool built for quick capture. Markdown-native, lightweight, and fully yours.

## Setup

```
go mod download
```

## Commands

```
go test ./...   # run the test suite
```

## Layout

- `web/`      541 source files
- `store/`    280 source files
- `server/`   151 source files
- `internal/` 99 source files
- `proto/`    19 source files
- `scripts/`  6 source files

## Conventions

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

## Gotchas

- `internal/markdown/parser/tag_unicode_tables.go` is 274KB. It will not fit comfortably in context, so read it in parts.

---

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.