Skip to content

CLAUDE.md

Latest commit

 

History

History
46 lines (41 loc) · 2.78 KB

CLAUDE.md

File metadata and controls

46 lines (41 loc) · 2.78 KB
Raw

chartplotter

A marine chart plotter in Go. It reads NOAA S-57 ENC cells, draws them with the S-101 Portrayal Catalogue, and bakes them into PMTiles vector-tile archives. A <chart-plotter> web component renders the tiles with MapLibre GL JS. The native libtile57 engine (Zig, the ./tile57 git submodule of github.com/beetlebugorg/tile57) does all tiling, portrayal, style, and asset generation, linked into the Go binary via CGO; the browser only renders pre-baked tiles. S-102 bathymetric support is planned.

Commands

  • make build — build bin/chartplotter. CGO build linking libtile57 (built on demand from the ./tile57 git submodule with Zig 0.16); the S-101 catalogue is embedded in the lib, so there's no separate sync/embed step. build fetches the submodule on demand (git submodule update --init --recursive) if it's missing, so a clone without --recurse-submodules still works. Needs git + Zig. (make build-tile57 is a back-compat alias.)
  • make test / make vet / make fmt — run before you commit.
  • make serve — build and serve web/ on :8080. Baked tiles are the only tile path: import/bake charts through the app (or bake), no live tile set.
  • make xbuild — cross-compile release binaries with zig cc (linux + windows, amd64/arm64). darwin is built natively on a macOS CI runner (Go's own runtime/cgo/crypto/x509 link Apple frameworks Zig doesn't bundle).

Conventions

  • CGO is required. libtile57 is the sole tile/portrayal engine, linked via CGO, so CGO_ENABLED=0 no longer builds. Cross-compilation is preserved with Zig as the C toolchain (zig cc), not by staying CGO-free. Pure-Go deps are still preferred where a native lib isn't the point (e.g. modernc.org/sqlite, not mattn/go-sqlite3). The ./tile57 submodule (with its nested IHO catalogue submodules) + Zig 0.16 are hard build deps.
  • Engine dev override. The default engine source is the ./tile57 git submodule — go.mod replaces the binding at ./tile57/bindings/go and the Makefile defaults TILE57 ?= tile57, so a plain --recurse-submodules clone needs no go.work. CI floats the submodule to the engine's latest main; the committed pin is last-known-good (bump it with git add tile57). go.work is OPTIONAL: use it only to build against a DIFFERENT engine checkout (e.g. a separate sibling clone you develop in), overriding BOTH halves — a gitignored go.work replacing github.com/beetlebugorg/tile57/bindings/go => <path>/bindings/go plus make TILE57=<path> …. Never commit go.work.
  • Use https://www.openbridge.no/ for design and icons.
  • Match the style of the code around you.
  • Never run git add -A or git add .. The repo holds large untracked files (testdata zips, PDFs, screenshots). Stage specific paths only.