[sikuli] 261/385: Update README.md
Gilles Filippini
pini at moszumanska.debian.org
Sun Jun 29 19:26:21 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 591073d9f739e1e4cd03748c88b2dce543124baa
Author: Raimund Hocke <rmhdevelop at me.com>
Date: Sun Feb 23 17:16:34 2014 +0100
Update README.md
---
README.md | 66 +++++++++++++++++++++++----------------------------------------
1 file changed, 24 insertions(+), 42 deletions(-)
diff --git a/README.md b/README.md
index 9a20a60..eba633a 100644
--- a/README.md
+++ b/README.md
@@ -16,14 +16,14 @@ Private complementing Websites: [Host Europe](https://www.hosteurope.de)
This Maven multi-module setup contains everything
-------------
-**to build the ready-to-use packages [available on Launchpad](https://launchpad.net/sikuli)** <br />(this is at least the intention at time of final release end January 2014).
+**to build the ready-to-use packages [available on Launchpad](https://launchpad.net/sikuli)**
**Forking and/or downloading this repo only makes sense:**
- if you want to get a knowledge about the internals of Sikuli
- if you want to create your own packages containing Sikuli features
- if you want to contribute.
-If you "only" want to use the SikuliX features developing in Java or any Java aware scripting language (Jython, JRuby, Scala. Closure, ...) it is strongly recommended to start with sikuli-java.jar (run Sikuli setup with option 4).
+If you "only" want to use the SikuliX features developing in Java or any Java aware scripting language (Jython, JRuby, Scala. Closure, ...) it is strongly recommended to start with sikuli-java.jar (run SikuliX setup with respective option ).
**To get the ready-to-use packages (IDE, Script, Java/Jython support) <br />it is still recommended [to start here](http://www.sikulix.com/download.html).**
@@ -44,38 +44,38 @@ The ready-to-use package `sikulixapi.jar` provides this API for Java programming
**Module IDE**
-Implements a GUI using Java, that allows to edit and run Sikuli scripts (currently only Jython is supported). It is an easy to use IDE focusing on the handling of the screenshots and images used in the typical Sikuli workflows.
+Implements a GUI using Java, that allows to edit and run Sikuli scripts (currently Jython and JRuby are supported). It is an easy to use IDE focusing on the handling of the screenshots and images used in the typical Sikuli workflows.
The package `sikulix.jar` is the top level package containing all other options (hence the follow up of `sikuli-ide.jar` known from former releases).
-This package `sikulix.jar` comes bundled with the Jython interpreter, thus allowing to run Sikuli scripts out of the box from the commandline and providing an interactive Sikuli aware Jython shell (hence it includes the functionality known from the `sikuli-script.jar` of former Sikuli(X) releases and is used the same way).
+After setup this package `sikulix.jar` contains the selected scripting interpreter(s) (Jython and/or JRuby), thus allowing to run Sikuli scripts out of the box from the commandline and providing an interactive Sikuli aware Jython shell (hence it includes the functionality known from the `sikuli-script.jar` of former Sikuli(X) releases and is used the same way).
<hr/>
**--- The helper/utility modules (intended for internal use only) ---**
**Module Jython**
-Implements Jython support for the IDE and for running scripts using Jython as scripting language.<br />
+Implements Jython support for the IDE and for running scripts using Python as scripting language.<br />
(contained in package sikulix.jar)
**Module JRuby**
-Implements JRuby support for the IDE and for running scripts using JRuby as scripting language.<br />
+Implements JRuby support for the IDE and for running scripts using Ruby as scripting language.<br />
(optionally contained in package sikulix.jar)
**Module Basics**
Implements basic utility 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).
+As a special feature it comprises the `sikulixsetup.jar`, which is run after download to build the wanted SikuliX packages and make them ready-to-use on the specific system (Windows, Mac or Linux).
**Module OpenCV4SikuliX**
-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).
+Sikuli's image search is based on 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.
+With the availability of the final version 1.1.0 the implementation of the OpenCV usage will be moved completely to the Java level. Until then the existing 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 libraries ready.
@@ -95,6 +95,10 @@ Contains the Java sources interface classes (JNI based, mainly SWIG generated) a
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.
+**Module Jygments4SikuliX**
+
+This is an adaption of the work [Jygments]() to the needs of SikuliX: it contains lexer/parser/formatter features and is a port from Python to Java of the well known Pygments tool, that is widely used for syntax highlighting and formatting of program code. It is intended to be used for syntax highlighting and other purposes, where scripting language grammar awareness is needed.
+
<hr/>
**--- The modules used to support package production (container jars) ---**
@@ -127,6 +131,12 @@ Currently as a convenience the standard tessdata folder needed for using Tessera
A template Sikuli-IDE.app, that is downloaded on request and made ready-to-use during Sikuli setup.
+**Modules ...Fat**
+Existing for IDE, API, Jython and JRuby. These build so called fat jars, that contain all needed dependency jars and are only intended for the build/setup process.
+
+**Module Setup**
+It produces the fat jar `sikulixsetup.jar` being the only downloadable artefact and allows to setup the SikuliX packages to be used on the local systems.
+
**Module Docs** (not Maven-ized yet)
The source files for the textual documentation (built with PythonSphinx based on .rst files) and a ready-to-use HTML version as well as a HTML version of the JavaDocs of the main public Java API.<br />
@@ -145,9 +155,9 @@ The source files for the textual documentation (built with PythonSphinx based on
Usage - basic information
-------------------------
-If you intend to compile and build the modules after having downloaded this repo, you need a valid Maven 3 installation and for editing, testing and integration some IDE, that is enabled for working with Maven projects. <br />(I myself use NetBeans 7.4, which supports Maven by default)
+If you intend to compile and build the modules after having downloaded this repo, you should have a valid Maven 3 installation and for editing, testing and integration some IDE, that is enabled for working with Maven projects. <br />(I myself use NetBeans 7.4, which supports Maven by default)
-**Take care** Even if you only want to work on one of the modules (e.g. API), the modules should not be moved around, but stay in the structure of the downloaded repo. Each module depends on the parent POM in the root as well as the ready-to-use-jar-production POMs, that additionally depend on the assembly descriptors plain.xml and complete.xml.
+**Take care** Even if you only want to work on one of the modules (e.g. API), the modules should not be moved around, but stay in the structure of the downloaded repo. Each module depends on the parent POM in the root as well as the ready-to-use-jar-production POMs, that additionally depend on the assembly descriptors.
**--- Mandatory first step**
@@ -155,41 +165,13 @@ In the root directory of the repo run <br />
`mvn clean install`<br />
which builds all modules and installs the artifacts into your local Maven repository.
+**Be aware** This mandatory first step will add "tons" of additional stuff from Maven Central repository to your local Maven repository, especially when you are a first time Maven user.
+
If you want jars containing the sources of the respective modules and/or containing the javadocs you can use the following profile switches:<br />
`mvn clean install -PwithSource,withDocs`<br />
(but for local usages, there might not be any sense in that ;-)
-**Be aware** This mandatory first step will add "tons" of additional stuff from Maven Central repository to your local Maven repository, especially when you are a first time Maven user.
-
-**--- Basic compile/package/install for each module**
-
-You have 3 options, to selectively run the POM of a specific module alone:
- 1. in the root folder run<br />`mvn -pl <ModuleName> [clean] [compile|package|install]` <br />where `<ModuleName>` is the respective folder name
- 2. in the module's folder run <br />`mvn [clean] [compile|package|install]`
- 3. use the respective build steps in your IDE being in one of the module projects
-
-You might additionally use the above mentioned profile switches.
-
-**--- Running the IDE or running scripts ---**
-
-In this Maven context the only runnable (means: should be run or makes sense to run) module is IDE (besides Basics with RunSetup), but this is sufficient, to get access to and test every aspect of Sikuli, since you can start the IDE, run scripts directly as well and start an interactive Jython session.
-
-Being in module IDE firing the RUN button in an IDE should start the Sikuli IDE showing the splash screen, that allows to enter parameters (and thus allowing to run scripts using option -r).
-
-The following Java settings are relevant for running Sikuli IDE from an IDE or using Maven:
- - -Dsikuli.Debug=3 sets a higher debug level from beginning (to debug startup problems)
- - -Dsikuli.console=false the equivalent of the option -c (script output goes to console)
- - -Dsikuli.FromCommandLine suppresses the startup splash screen (set parameters in IDE project run setup instead)
-
-Debugging should work without problems, when starting the module IDE in debug mode.
-
-The mudule IDE POM contains the exec-maven-plugin, so to run the Sikuli IDE you can use being in the IDE folder<br />
-`mvn exec:java -Dsikuli.FromCommandLine -Dexec.args="args for Sikuli"`
-
-or this being in the root folder <br />
-`mvn -pl IDE exec:java -Dsikuli.FromCommandLine -Dexec.args="args for Sikuli"`
-
-As it is standard with Maven, all -D parameters go to Java system properties, wheras the content of -Dexec.args string will be given to the args array for the main method of the startup class.
+More details you can find [here ...](https://github.com/RaiMan/SikuliX-2014/wiki/More-information-related-to-the-Maven-aspects-in-this-project)
**--- How to produce the ready to use jars ---**
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/sikuli.git
More information about the pkg-java-commits
mailing list