From fb78dbcdc5a76997856285af3b041ffd087c40a5 Mon Sep 17 00:00:00 2001 From: Josh Heidenreich Date: Mon, 6 Feb 2012 13:22:05 +1030 Subject: Added READMEs for modules related to URE, with content from the wiki --- bridges/README | 4 ++++ cli_ure/README | 5 +++++ codemaker/README | 2 ++ cppu/README | 4 ++++ cppuhelper/README | 4 ++++ cpputools/README | 1 + idlc/README | 2 ++ io/README | 2 ++ javaunohelper/README | 2 ++ jurt/README | 2 ++ jvmaccess/README | 1 + jvmfwk/README | 1 + offapi/README | 4 ++++ pyuno/README | 1 + rdbmaker/README | 4 ++++ registry/README | 1 + remotebridges/README | 1 + ridljar/README | 1 + sal/README | 9 +++++++++ salhelper/README | 1 + stoc/README | 1 + store/README | 1 + udkapi/README | 6 ++++++ unoil/README | 1 + ure/README | 10 ++++++++++ xml2cmp/README | 3 +++ 26 files changed, 74 insertions(+) create mode 100644 bridges/README create mode 100644 cli_ure/README create mode 100644 codemaker/README create mode 100644 cppu/README create mode 100644 cppuhelper/README create mode 100644 cpputools/README create mode 100644 idlc/README create mode 100644 io/README create mode 100644 javaunohelper/README create mode 100644 jurt/README create mode 100644 jvmaccess/README create mode 100644 jvmfwk/README create mode 100644 offapi/README create mode 100644 pyuno/README create mode 100644 rdbmaker/README create mode 100644 registry/README create mode 100644 remotebridges/README create mode 100644 ridljar/README create mode 100644 sal/README create mode 100644 salhelper/README create mode 100644 stoc/README create mode 100644 store/README create mode 100644 udkapi/README create mode 100644 unoil/README create mode 100644 ure/README create mode 100644 xml2cmp/README diff --git a/bridges/README b/bridges/README new file mode 100644 index 000000000000..7c0eee30bbba --- /dev/null +++ b/bridges/README @@ -0,0 +1,4 @@ +Bridges from various C++ ABIs, Java JNI, MS .Net to UNO and back. + +Also implementation of the UNO Remote Protocol. And in ooo-build a bridge from Mono to UNO and back. + diff --git a/cli_ure/README b/cli_ure/README new file mode 100644 index 000000000000..8f173dffe8ab --- /dev/null +++ b/cli_ure/README @@ -0,0 +1,5 @@ +Common Lang Infrastructure Uno Runtime Environment - support assemblies and tools for the MS .Net (and Mono) UNO binding. + +See also: +[git:cli_ure/source/readme.txt] + diff --git a/codemaker/README b/codemaker/README new file mode 100644 index 000000000000..96a08ac3f4a6 --- /dev/null +++ b/codemaker/README @@ -0,0 +1,2 @@ +UNO interface declaration/stub generators for C++ (headers), Java (class files), ... the one for .Net is in cli_ure. + diff --git a/cppu/README b/cppu/README new file mode 100644 index 000000000000..0baacca97a29 --- /dev/null +++ b/cppu/README @@ -0,0 +1,4 @@ +Type definitions/implementations for the core of UNO. The exported API is in C. + +See also: +[http://wiki.services.openoffice.org/wiki/Uno/Binary/Modules/CPPU] diff --git a/cppuhelper/README b/cppuhelper/README new file mode 100644 index 000000000000..f69652c26bdd --- /dev/null +++ b/cppuhelper/README @@ -0,0 +1,4 @@ +Helpers for using cppu in C++, e.g. templates for implementing UNO components, bootstrapping stuff. Get UNO up and running. + +See also: +[http://wiki.services.openoffice.org/wiki/Uno/Cpp/Modules/CPPUhelper] diff --git a/cpputools/README b/cpputools/README new file mode 100644 index 000000000000..9652827ca123 --- /dev/null +++ b/cpputools/README @@ -0,0 +1 @@ +Old way of doing component registration. Nowadays replaced by another stand-alone UI and tools called UNO package. diff --git a/idlc/README b/idlc/README new file mode 100644 index 000000000000..877702af52da --- /dev/null +++ b/idlc/README @@ -0,0 +1,2 @@ +Contains the IDL compiler. + diff --git a/io/README b/io/README new file mode 100644 index 000000000000..b721ef4758ea --- /dev/null +++ b/io/README @@ -0,0 +1,2 @@ +Simple IO wrappers. + diff --git a/javaunohelper/README b/javaunohelper/README new file mode 100644 index 000000000000..9896ef15c629 --- /dev/null +++ b/javaunohelper/README @@ -0,0 +1,2 @@ +Makes it easier to use UNO with Java. + diff --git a/jurt/README b/jurt/README new file mode 100644 index 000000000000..a2281d24bdca --- /dev/null +++ b/jurt/README @@ -0,0 +1,2 @@ +JURT means Java Uno Runtime and implements most of Java UNO. + diff --git a/jvmaccess/README b/jvmaccess/README new file mode 100644 index 000000000000..54af22469516 --- /dev/null +++ b/jvmaccess/README @@ -0,0 +1 @@ +Wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with more ease. diff --git a/jvmfwk/README b/jvmfwk/README new file mode 100644 index 000000000000..54af22469516 --- /dev/null +++ b/jvmfwk/README @@ -0,0 +1 @@ +Wrappers so you can use all the Java Runtime Environments with their slightly incompatible APIs with more ease. diff --git a/offapi/README b/offapi/README new file mode 100644 index 000000000000..c33424d4a7e5 --- /dev/null +++ b/offapi/README @@ -0,0 +1,4 @@ +Contains all of the IDL files except those in [[udkapi]] + +i.e. the interfaces that are specific to the OppenOffice.org application. +An artificial (?) separation. diff --git a/pyuno/README b/pyuno/README new file mode 100644 index 000000000000..57853a9c90e2 --- /dev/null +++ b/pyuno/README @@ -0,0 +1 @@ +UNO bindings for the Python programming language. diff --git a/rdbmaker/README b/rdbmaker/README new file mode 100644 index 000000000000..56f48a8683b2 --- /dev/null +++ b/rdbmaker/README @@ -0,0 +1,4 @@ +Makes registries for openoffice for storing type data + +See also: +[http://wiki.services.openoffice.org/wiki/Uno/Binary/Modules/rdbmaker] diff --git a/registry/README b/registry/README new file mode 100644 index 000000000000..b455809406a7 --- /dev/null +++ b/registry/README @@ -0,0 +1 @@ +Registry reading, etc. diff --git a/remotebridges/README b/remotebridges/README new file mode 100644 index 000000000000..cfe0d196afef --- /dev/null +++ b/remotebridges/README @@ -0,0 +1 @@ +UNO services dealing with interprocess bridges. diff --git a/ridljar/README b/ridljar/README new file mode 100644 index 000000000000..0f3afff183a8 --- /dev/null +++ b/ridljar/README @@ -0,0 +1 @@ +Implements types for the Java Uno typesystem. diff --git a/sal/README b/sal/README new file mode 100644 index 000000000000..324c64fa4a78 --- /dev/null +++ b/sal/README @@ -0,0 +1,9 @@ +System abstraction layer; rtl, osl and sal + +rtl: +Platform independent strings + +osl: +platform specific stuff, threads, dynamic loading, process, ipc, etc + +Exports only C API and some inline-methods (only C++ API). diff --git a/salhelper/README b/salhelper/README new file mode 100644 index 000000000000..019a562df485 --- /dev/null +++ b/salhelper/README @@ -0,0 +1 @@ +C++ helpers to make use of sal easier. diff --git a/stoc/README b/stoc/README new file mode 100644 index 000000000000..db0e8574abf7 --- /dev/null +++ b/stoc/README @@ -0,0 +1 @@ +Registries, reflection, introspection implementation for UNO. diff --git a/store/README b/store/README new file mode 100644 index 000000000000..8b003291723e --- /dev/null +++ b/store/README @@ -0,0 +1 @@ +Streams, mmaps, etc. diff --git a/udkapi/README b/udkapi/README new file mode 100644 index 000000000000..3510fddc9150 --- /dev/null +++ b/udkapi/README @@ -0,0 +1,6 @@ +Low level UNO stuff API IDL files + +i.e. those that are part of the standalone URE. + +See also: +[[offapi]] diff --git a/unoil/README b/unoil/README new file mode 100644 index 000000000000..9ccd36d2501a --- /dev/null +++ b/unoil/README @@ -0,0 +1 @@ +As offuh but for Java UNO: Maps IDL into java classes definitions. diff --git a/ure/README b/ure/README new file mode 100644 index 000000000000..f99174ab6530 --- /dev/null +++ b/ure/README @@ -0,0 +1,10 @@ +Contains the UNO Runtime Environment (URE). + +Beginnings of standalone UNO distribution. + +See also: +[http://udk.openoffice.org/] + +You may also want to read the README located at: +[git:ure/source/README] + diff --git a/xml2cmp/README b/xml2cmp/README new file mode 100644 index 000000000000..d8e12d439c51 --- /dev/null +++ b/xml2cmp/README @@ -0,0 +1,3 @@ +Part of the LibreOffice SDK. + +Mostly used by makefiles to pull out types from xml. -- cgit