forkless/Piperless
1
0
Fork 0
mirror of https://github.com/forkless/Piperless.git synced 2026-08-18 09:29:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document Makefile targets in README and developer docs

Browse Source
This commit is contained in:
Forkless
2026-05-11 22:22:33 +02:00
parent 198a05d559
commit 7278b522a7
2 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17
View File
@@ -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.
doc/index.html
+18
View File
@@ -438,6 +438,24 @@ for deterministic attribution.
<li>@ suppression on filesystem calls with error_clear_last() + log_last_error() for diagnostics</li>
</ul>
<h2 id="build">Build &amp; Tooling</h2>
<p>The <code>Makefile</code> wraps the build and translation toolchain:</p>
<table>
<tr><th>Command</th><th>Action</th></tr>
<tr><td><code>make build</code></td><td>Create piperless-X.Y.Z.zip</td></tr>
<tr><td><code>make translations</code></td><td>Extract .pot → JSON, sync to all locales</td></tr>
<tr><td><code>make json2po</code></td><td>Convert JSON translations back to .po/.mo</td></tr>
<tr><td><code>make check-translations</code></td><td>Validate translation integrity</td></tr>
<tr><td><code>make lock-translations</code></td><td>Lock all locales for translation work</td></tr>
<tr><td><code>make unlock-translations</code></td><td>Release all translation locks</td></tr>
<tr><td><code>make translation-status</code></td><td>Show lock/completion for each locale</td></tr>
<tr><td><code>make clean</code></td><td>Remove build artifacts</td></tr>
</table>
<p>All tools run as standalone shell scripts in <code>tools/</code> — the Makefile is a convenience wrapper.</p>
</main>
</body>
</html>