Skip to content

Public readiness: proper README + community health files #10

Description

@DocGerd

Write a real README before the repo goes public: what SailCommand is (offline-capable passage-planning PWA for Flensburg Fjord / Danish South Sea, Salona 45), screenshots, architecture sketch (pipeline → static assets → PWA with worker-based isochrone router), build/run instructions (app + pipeline incl. the ~900 MB source downloads and cache behavior), test instructions (incl. the ~200 s property suite and per-file CI timeout policy), data provenance section (EMODnet CC-BY 4.0, OSM ODbL, Protomaps), and the not-a-navigation-device disclaimer prominently. Add SECURITY.md (private vulnerability reporting) and a minimal CONTRIBUTING.md (worktree/PR/review conventions used here).

Part of the public-readiness batch — do not implement until the app phases are done.

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions