summaryrefslogtreecommitdiffstats
path: root/odk/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'odk/README.md')
-rw-r--r--odk/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/odk/README.md b/odk/README.md
new file mode 100644
index 000000000..ee54679bb
--- /dev/null
+++ b/odk/README.md
@@ -0,0 +1,29 @@
+# Office Development Kit (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/`)
+
+* 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.
+
+* 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
+
+ `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.)