[sikuli] 36/385: Update README.md

Gilles Filippini pini at moszumanska.debian.org
Sun Jun 29 19:25:45 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 99a5d3ef98e47bf7eadc0cb71ddd6d06aafa2711
Author: Raimund Hocke <rmhdevelop at me.com>
Date:   Thu Dec 26 11:52:15 2013 +0100

    Update README.md
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index f1e4f87..a4a96c8 100644
--- a/README.md
+++ b/README.md
@@ -24,8 +24,18 @@ Each folder (module) in this repo is a Maven project by itself with its own POM,
 
 **Module API**
 
+The Java implementation comprising the API to access the top elements (Screen, Region, Pattern, Match, Image, ...) and their methods allowing to search for images and to act on points and matches simulating mouse and keyboard.
+
+The base package `sikuli-java.jar` provides this API for Java programming and any Java aware scripting languages (currently with some special support for Jython).
+
+The convenience package `sikuli-script.jar` comes with the bundled Jython interpreter, thus allowing to run Sikuli scripts out of the box from the commandline and providing an interactive Sikuli aware Jython shell.
+
 **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.
+
+The package `sikuli-ide.jar` is the top level package containing all other options and can be used in the same way.
+
 <hr/>
 
 **--- The helper/utility modules (intended for internal use only) ---**

-- 
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