erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-12 11:55:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

docs(common): improve formatting of builder.md

Browse source
This commit is contained in:
Eberhard Beilharz 2024-05-06 15:07:37 +02:00
parent 9c7e2c879a
commit 2dffec366c
No known key found for this signature in database
GPG key ID: E9140597606020D3
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
resources/build/builder.md
View file

@ -86,13 +86,12 @@ This somewhat unwieldy incantation handles all our build environments.
The intent is to get a good solid consistent path for the script so that we can
safely include the build script, no matter what `pwd` is when the script is run.
The only modification permissible in this block is the
`<relative-path-to-repo-root>` text which will be a series of `../` paths taking
us to the repository root from the location of the script itself.
It is essential to make the include relative to the repo root, even for scripts
under the resources/ folder. Doing this gives us significant performance
under the `resources/` folder. Doing this gives us significant performance
benefits.
Inclusion of other scripts should be kept outside this standard build script
@ -1030,4 +1029,4 @@ Note: it is recommended that you use `$(builder_term text)` instead of
[`builder_echo`]: #builderecho-function
[`builder_die`]: #builderdie-function
[`builder_echo_debug`]: #builderechodebug-function
[`builder_is_debug_build`]: #builderisdebugbuild-function
[`builder_is_debug_build`]: #builderisdebugbuild-function