ajhahn.de
← eeco
plain text 49 lines
<!-- Scaffolded by `eeco docs new readme` (eeco {{.Version}}).
     Edit freely; delete this comment once the doc is yours. -->

# {{.Project}}

One-line tagline: what {{.Project}} does, in plain language. Aim for a
sentence a stranger can repeat after one read.

Two short paragraphs explaining what {{.Project}} is, who it is for,
and why it exists. Lead with the problem it solves; close with the
shape of the solution. Keep it concrete — link out to a longer guide
for detail rather than restating one here.

## Quick start

Install:

```
# replace with the install recipe that fits this project
```

Run:

```
# the one command a new reader should try first
```

## How it works

Two or three sentences on the moving parts: where the code lives, what
it talks to, and what state it keeps. The goal is to orient a reader
who is about to open the source tree, not to replace an architecture
doc.

<!-- eeco:docs:start -->
## See also
{{- if .HasUsage}}

- [docs/USAGE.md](docs/USAGE.md) — full user reference
{{- end}}
{{- if .HasArch}}
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) — architecture overview
{{- end}}
{{- if and (not .HasUsage) (not .HasArch)}}

- (no related docs detected — link out as the project grows)
{{- end}}
<!-- eeco:docs:end -->