diff options
| author | Hossein <hossein.ir@gmail.com> | 2021-03-29 21:55:26 +0430 |
|---|---|---|
| committer | Adolfo Jayme Barrientos <fitojb@ubuntu.com> | 2021-04-07 17:47:16 +0200 |
| commit | ea5641baeef73af60d025d185901a303844e2d85 (patch) | |
| tree | 94b343b35e7b8805beb9a1745fe1de2f382574fb /odk | |
| parent | 33da78c21f4243a3e469fb7df79ed1745df70078 (diff) | |
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md
and now, the contents of these files were changed to use Markdown
format. Other than format inconsistency, some README.md files lacked
information about modules, or were out of date. By using LibreOffice
/ OpenOffice wiki and other documentation websites, these files were
updated. Now every README.md file has a title, and some description.
The top-level README.md file is changed to add links to the modules.
The result of processing the Markdown format README.md files can be
seen at: https://docs.libreoffice.org/
Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424
Tested-by: Jenkins
Reviewed-by: Michael Stahl <michael.stahl@allotropia.de>
Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'odk')
| -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.) |