build: Attempt to self-document the makefile.

This commit is contained in:
2024-11-25 21:11:36 -05:00
parent 507b069ffe
commit beedbd7646
2 changed files with 126 additions and 54 deletions

View File

@ -37,11 +37,10 @@ The `.tar.xz` source releases are all-inclusive.
1. On Linux only, system OpenSSL libraries (`libssl-dev`, in debian-speak) are
assumed to be available.
2. To build, run `make debug` or `make release`. An executable will be
generated in a subdirectory of `out/`.
2. Run `make` with no arguments to see available build targets and options.
`make debug` is a good place to start.
3. It's possible to build for Android, iOS, and Windows on Linux, if you have
the right dependencies in the right places. `make windebug winrelease
iosdebug-ipa iosrelease-ipa release-apk`.
the right dependencies in the right places.
4. To build in docker, `docker build .`.
5. `make format` will normalize formatting to the coding standard.