diff options
| author | Paul Buetow <paul@buetow.org> | 2026-07-03 23:20:15 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-07-03 23:20:15 +0300 |
| commit | 0568500f539bb93645d654cc9320835e2d7f91d6 (patch) | |
| tree | 97a909e2cb63d95393475322f93784d37c8a9a0c | |
| parent | 30dd2c01e6996f81571d752c0ef09db13f942780 (diff) | |
docs: add AGENTS.md (with f3s skill pointer) and CLAUDE.md
Amp-Thread-ID: https://ampcode.com/threads/T-019f299f-7596-73b6-ba71-0f71fcd3c131
Co-authored-by: Amp <amp@ampcode.com>
| -rw-r--r-- | AGENTS.md | 29 | ||||
| -rw-r--r-- | CLAUDE.md | 1 |
2 files changed, 30 insertions, 0 deletions
diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..739d2a0 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,29 @@ +# AGENTS.md + +Guidance for coding agents working in this repository. + +## Repository + +Three small legacy C++ projects sharing a socket/event/template engine: +`ychat/` (HTTP web chat server), `yhttpd/` (tiny standalone HTTP server), and +`ycurses/` (curses front-end demo). See [README.md](README.md) for the +overview and local Docker/podman quickstart, and +[ychat/DOCKER.md](ychat/DOCKER.md) for the detailed ychat build notes. + +## Building and running + +Everything builds **inside Docker/podman** — no host toolchain required. Use +the multi-stage `Dockerfile` in each subproject. For local build-and-run +steps, follow [README.md](README.md) and the per-subproject `DOCKER.md` / +`BUILD.md` files. + +## Deployment (homelab-only, not in this repo) + +Deploying ychat to the f3s homelab k3s cluster (private registry push, Helm +chart, ArgoCD Application, PVC for `/app/data`) is **homelab-specific and +deliberately not documented in this public repo**. + +If you are running with the private `f3s` Amp skill available, its +`references/ychat.md` reference has the full deployment runbook (image +build/push, Helm chart path, ArgoCD app, storage/PVC notes). Load the `f3s` +skill for those details. Without that skill, treat deployment as out of scope. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..9144b3d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +See [AGENTS.md](AGENTS.md) for guidance on working in this repository. |