[sikuli] 85/385: added module READMEs

Sun Jun 29 19:25:52 UTC 2014

This is an automated email from the git hooks/post-receive script.

pini pushed a commit to tag upstream/1.1.0_beta1
in repository sikuli.

commit 91f711087f46b0d84f5a27c7f12bf9799790bc5c
Author: Raimund Hocke <rmhdevelop at me.com>
Date:   Sun Dec 29 14:47:17 2013 +0100

    added module READMEs
---
 Basics/README.md    |  7 +++++++
 Jython/README.md    |  6 ++++++
 Libs/README.md      | 20 ++++++++++++++++++++
 MacApp/README.md    |  5 +++++
 Natives/README.md   |  7 +++++++
 OpenCV/README.md    | 13 +++++++++++++
 Tesseract/README.md |  6 ++++++
 7 files changed, 64 insertions(+)

diff --git a/Basics/README.md b/Basics/README.md
new file mode 100644
index 0000000..265b963
--- /dev/null
+++ b/Basics/README.md
@@ -0,0 +1,7 @@
+Sikuli Basics 2014 (version 1.1.x)
+===
+
+Implements basic ustility and helper features used in the top level packages (basic file and folder handling, download features, jar access and handling, export of native libraries, parameter and preferences handling, update and extension handling, ...) and hence it is contained in all packages.
+
+As a special feature it comprises the `sikuli-setup.jar`, which is run after download to build the wanted Sikuli packages and make them ready-to-use on the specific system (Windows, Mac or Linux).
+
diff --git a/Jython/README.md b/Jython/README.md
new file mode 100644
index 0000000..03ea9a0
--- /dev/null
+++ b/Jython/README.md
@@ -0,0 +1,6 @@
+Sikuli Jython 2014 (version 1.1.x)
+===
+
+Implements the Jython support for the IDE and for running scripts using Jython as scripting language.<br />
+(contained in packages sikuli-ide.jar and sikuli-script.jar)
+
diff --git a/Libs/README.md b/Libs/README.md
new file mode 100644
index 0000000..27930b3
--- /dev/null
+++ b/Libs/README.md
@@ -0,0 +1,20 @@
+Sikuli Libs 2014 (version 1.1.x)
+===
+
+The prebuilt native libraries for Windows, Mac and Linux (partially).<br />
+(contained in `sikuli-setup.jar`)
+
+It contains a Maven workflow to execute build scripts for the native libraries on the system running on:
+ - Windows (not yet ready): WinUtil.dll, VisionProxy.dll
+ - Mac: libMacHotkeyManager.dylib, libMacUtil.dylib, libVisionProxy.dylib
+ - Linux: libVisionProxy.so
+
+To run it from the project root folder:<br />
+`mvn -f Libs/x*`
+
+The build scripts are in the respective system folder in folder `build` <br />
+The built libraries will directly go to the respective resources folder. <br />
+In case of errors you have to check the prerequisites: [look here ...](https://github.com/RaiMan/SikuliX-2014/wiki/How-to-prepare-for-and-build-the-native-libraries)
+
+For Linux there will still be a supplemental package available on the download page, that allows to build libVisionProxy.so
+
diff --git a/MacApp/README.md b/MacApp/README.md
new file mode 100644
index 0000000..b5bcde1
--- /dev/null
+++ b/MacApp/README.md
@@ -0,0 +1,5 @@
+Sikuli MacApp 2014 (version 1.1.x)
+===
+
+A template Sikuli-IDE.app, that is downloaded on request and made ready-to-use during Sikuli setup.
+
diff --git a/Natives/README.md b/Natives/README.md
new file mode 100644
index 0000000..ebb4a19
--- /dev/null
+++ b/Natives/README.md
@@ -0,0 +1,7 @@
+Sikuli Natives 2014 (version 1.1.x)
+===
+
+Contains the Java sources interface classes (JNI based, mainly SWIG generated) and the C++ sources providing the implementation of the OpenCV and Tesseract usage and the implementation of some system specific features (HotKeyHandling, App class support,...).
+
+A maven based build workflow for the native libraries (libVisionProxy, lib...Util and hotky support on Mac) is available in the module Libs, which is also the target module for the prebuilt libraries finally bundled with the top level packages.
+
diff --git a/OpenCV/README.md b/OpenCV/README.md
new file mode 100644
index 0000000..ee7bf67
--- /dev/null
+++ b/OpenCV/README.md
@@ -0,0 +1,13 @@
+Sikuli OpenCV 2014 (version 1.1.x)
+===
+
+Sikuli's image search is based on respective features of [OpenCV](http://opencv.org). Starting with version 2.4.6 OpenCV provides a self-contained JNI interface to the OpenCV native libraries, allowing to use OpenCV features directly in Java (and hence making C++ programming obsolete for this).
+
+This module contains a specially configured Java/JNI OpenCV package (built using the standard OpenCV configure/make workflow) for use with the OpenCV features currently needed by Sikuli (core, imgproc, feature2d and highgui). The corresponding native library pack (currently Mac only) is contained in the module Libs.
+
+With the final availability of version 1.1.0 the implementation of the OpenCV usage will be moved completely to the Java level. Until then the historical implementation in C++ is activated in the standard. The usage of the new implementation (in the new classes ImageFinder and ImageFind) can be switched on optinally for testing and developement.
+
+For Windows and Mac the native packages will again be pre-built and ready-to-use. For Linux there will be advices and scripts available to get the needed features.
+
+For more information on preparation and usage of the new OpenCV Java API [look here ...](https://github.com/RaiMan/SikuliX-2014/wiki/How-to-prepare-and-use-the-new-OpenCV-Java-API)
+
diff --git a/Tesseract/README.md b/Tesseract/README.md
new file mode 100644
index 0000000..7aed40d
--- /dev/null
+++ b/Tesseract/README.md
@@ -0,0 +1,6 @@
+Sikuli Tesseract 2014 (version 1.1.x)
+===
+
+Currently as a convenience the standard tessdata folder needed for using Tesseract 3.0.<br />
+(will be downloaded on request during a Sikuli setup)
+

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/sikuli.git

