From 7278b522a78c8f22474ed7b992df898ac3f33d62 Mon Sep 17 00:00:00 2001 From: Forkless Date: Mon, 11 May 2026 22:22:33 +0200 Subject: [PATCH] Document Makefile targets in README and developer docs --- README.md | 17 +++++++++++++++++ doc/index.html | 18 ++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/README.md b/README.md index b04d293..42c46a6 100644 --- a/README.md +++ b/README.md @@ -211,6 +211,23 @@ includes/ └── class-logger.php # PSR-3 logger with dual-channel fallback ``` +### Build & Tooling + +The `Makefile` wraps the build and translation toolchain: + +``` +make build → Create piperless-X.Y.Z.zip +make translations → Extract .pot → JSON, sync to all locales +make json2po → Convert JSON translations back to .po/.mo +make check-translations → Validate translation integrity +make lock-translations → Lock all locales for translation work +make unlock-translations → Release all translation locks +make translation-status → Show lock/completion for each locale +make clean → Remove build artifacts +``` + +All tools run as standalone shell scripts in `tools/` — the Makefile is a convenience wrapper. + See `doc/index.html` for full developer documentation with architecture diagram, method tables, and security model. diff --git a/doc/index.html b/doc/index.html index f171113..daef819 100644 --- a/doc/index.html +++ b/doc/index.html @@ -438,6 +438,24 @@ for deterministic attribution.
  • @ suppression on filesystem calls with error_clear_last() + log_last_error() for diagnostics
  • +

    Build & Tooling

    + +

    The Makefile wraps the build and translation toolchain:

    + + + + + + + + + + + +
    CommandAction
    make buildCreate piperless-X.Y.Z.zip
    make translationsExtract .pot → JSON, sync to all locales
    make json2poConvert JSON translations back to .po/.mo
    make check-translationsValidate translation integrity
    make lock-translationsLock all locales for translation work
    make unlock-translationsRelease all translation locks
    make translation-statusShow lock/completion for each locale
    make cleanRemove build artifacts
    + +

    All tools run as standalone shell scripts in tools/ — the Makefile is a convenience wrapper.

    +