diff options
Diffstat (limited to 'odk/README.md')
| -rw-r--r-- | odk/README.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/odk/README.md b/odk/README.md index 4370e63e594f..ee54679bb13c 100644 --- a/odk/README.md +++ b/odk/README.md @@ -1,27 +1,29 @@ -Office development kit - implements the first step on the way to the LibreOffice SDK tarball. +# Office Development Kit (odk) -Part of the SDK; to build you need to add --enable-odk. +Office development kit (`odk`) - implements the first step on the way to the LibreOffice SDK +tarball. +Part of the SDK; to build you need to add `--enable-odk`. -Testing the examples: -===================== -* Go to instdir/sdk (Don't try directly in odk/) +## Testing the Examples: + +* Go to `instdir/sdk` (Don't try directly in `odk/`) * See <https://api.libreoffice.org/docs/install.html> how to set up the SDK. -** When asked about it during configuration, tell the SDK to do automatic - deployment of the example extensions that get built. + * When asked about it during configuration, tell the SDK to do automatic + deployment of the example extensions that get built. -* In a shell set up for SDK development, build (calling "make") and test - (following the instructions given at the end of each "make" invocation) each - of the SDK's examples/ sub-directories. +* In a shell set up for SDK development, build (calling `make`) and test + (following the instructions given at the end of each `make` invocation) each + of the SDK's `examples/` sub-directories. -** An example script to build (though not test) the various examples in batch - mode is + * An example script to build (though not test) the various examples in batch + mode is - find examples \( -type d -name nativelib -prune \) -o \ - \( -name Makefile -a -print -a \( -execdir make \; -o -quit \) \) + `find examples \( -type d -name nativelib -prune \) -o \` + `\( -name Makefile -a -print -a \( -execdir make \; -o -quit \) \)` - (Note that one of the example extensions asks you to accept an example - license on stdin during deployment.) + (Note that one of the example extensions asks you to accept an example + license on stdin during deployment.) |