Add LOK Readme.

1 files changed, 41 insertions, 0 deletions

diff --git a/libreofficekit/README b/libreofficekit/README
new file mode 100644
index 000000000000..267b20b1340c
--- /dev/null
+++ b/libreofficekit/README
@@ -0,0 +1,41 @@
+LibreOfficeKit
+**************
+
+LibreOfficeKit can be used for accessing LibreOffice functionality
+outwith LibreOffice, through C/C++, without any need to use UNO.
+
+For now it only offers document conversion (in addition to an experimental
+tiled rendering API).
+
+Integrating LOK into other software
+-----------------------------------
+
+You will need to integrate shim.c into your program, e.g. as a static library,
+in order to be able to use LOK. You will then be able to access LOK via
+the functions in LibreOfficeKit.h[xx].
+
+(LibreOfficeKit.hxx is a simple and fully inlined C++ wrapper for the same
+ functionality as in LibreOfficeKit.h.)
+
+An example program can be seen on:
+https://github.com/ojwb/lloconv	
+
+Tiled Rendering
+---------------
+
+To use LOK Tiled Rendering you will need the follwing before the LOK includes:
+#define LOK_USE_UNSTABLE_API
+
+Currently only bitmap-buffer rendering is supported, with a 32-bit RGBA
+colourspace (further alternatives could feasibly be implemented as needed).
+Scanlines are ordered top-down (whereas LibreOffice will internally default
+to bottom-up).
+
+LibreOfficeKitGtk
+*****************
+
+Currently consists of only a very basic gtk+ document viewer widget.
+
+Currently this simply renders the entire document as one large tile (for
+writer) and/or entire sheet for calc, which can be somewhat slow with
+larger documents.