Skip to content

Commit 02f8d3a

Browse files
Update docs at v2.0.6
1 parent ecc1d6a commit 02f8d3a

3 files changed

Lines changed: 771 additions & 815 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@ Sikuli Robot Framework Library
22
==============================
33

44
## Introduction
5-
Sikuli Robot Framework Library provides keywords to be used within [Robot Framework's](https://robotframework.org/) environment to test UI through [Sikulix](http://sikulix.com/), a automation tool that uses image recognition to identify and interact with UI components.
5+
Sikuli Robot Framework Library provides keywords to be used within [Robot Framework's](https://robotframework.org/) environment to test UI through [SikuliX](http://sikulix.com/), a automation tool that uses image recognition to identify and interact with UI components.
66

7-
This library supports python 2.x, and python 3.x
7+
This library supports Python 3.8 - 3.14.
88

99
## Mapping With Sikulix API Version
10-
As this library is depended with sikulixapi, below table describe the mapping between SikuliLibrary version and sikulixapi version.
11-
Before using this library, please check [doc of sikulix](https://sikulix-2014.readthedocs.io/en/latest/index.html), and make sure the environment satisfy the requirement of sikulix.
10+
As this library is dependent of SikuliX API, below table describe the mapping between SikuliLibrary version and SikuliX API version.
11+
Before using this library, please check [doc of sikulix](https://sikulix-2014.readthedocs.io/en/latest/index.html), and make sure the environment satisfy the requirement of SikuliX.
1212

13-
| SikuliLibrary | sikulixapi |
13+
| SikuliLibrary | SikuliX API |
1414
| --- | --- |
1515
| master | 2.0.5 |
16+
| 2.0.6 | 2.0.5 |
1617
| 2.0.5 | 2.0.5 |
1718
| 2.0.3 | 2.0.4 |
1819
| 2.0.0 | 2.0.4 |
@@ -30,18 +31,18 @@ Before using this library, please check [doc of sikulix](https://sikulix-2014.re
3031

3132
## Keyword Documentation
3233

33-
Here is a list of the available [Keywords :full_moon_with_face:](http://MarketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary.html) | [Keywords :new_moon_with_face:](http://MarketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary_dark.html).
34+
Here is a list of the available [Keywords :full_moon_with_face:](http://marketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary.html) | [Keywords :new_moon_with_face:](http://marketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary_dark.html).
3435

35-
Previous version, [2.0.3 :full_moon_with_face:](http://MarketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary_2.0.3.html).
36+
Previous version, [2.0.3 :full_moon_with_face:](http://marketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary_2.0.3.html).
3637

3738
# Getting Started
3839

39-
This guide will take you through setting up Robot Framework with Sikuli Library, on a Windows machine.
40+
This guide will take you through setting up Robot Framework with SikuliLibrary, on a Windows machine.
4041

4142

4243
## Step 1: Install the basic components
4344

44-
Make sure you have at least Java 11 installed, and Python 3.8 to 3.13, and [pip](https://pypi.org/project/pip/)
45+
Make sure you have at least Java 11 installed, and Python 3.8 to 3.14, and [pip](https://pypi.org/project/pip/)
4546

4647
Run the command line below to check the currently version that you have installed:
4748

@@ -59,6 +60,7 @@ Using pip, you can install Robot Framework
5960
pip install robotframework
6061
```
6162
And then install the library
63+
6264
```
6365
pip install robotframework-SikuliLibrary
6466
```
@@ -80,11 +82,11 @@ mvn package
8082
* To install with Python, you create a wheel package and then install:
8183
```
8284
pip wheel .
83-
pip install ./robotframework_sikulilibrary-2.0.5-py3-none-any.whl
85+
pip install ./robotframework_sikulilibrary-2.0.6-py3-none-any.whl
8486
```
8587

8688
### Note
87-
* For Linux, there are some dependencies that needs to be installed, please check [sikuli quick start](http://www.sikulix.com/specials/files/linux-setup-prerequisites.html) to get more details.
89+
* For Linux, there are some dependencies that needs to be installed, please check [SikuliX quick start](http://www.sikulix.com/specials/files/linux-setup-prerequisites.html) to get more details.
8890
* Python should be installed as maven will execute python command
8991
* OS should allow Java process access Internet
9092

@@ -194,7 +196,7 @@ Library Remote http://<ip>:<port>/
194196

195197
## "NEW" mode
196198
* By default, SikuliLibrary will start Sikuli Java process implicitly when library is initializing by Robot Framework. This behavior brings some problems.
197-
* Now with **"NEW"** mode, user could use keyword [Start Sikuli Process](http://MarketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary.html#Start%20Sikuli%20Process) to start the process explicitly.
199+
* Now with **"NEW"** mode, user could use keyword [Start Sikuli Process](http://marketSquare.github.io/robotframework-SikuliLibrary/docs/SikuliLibrary.html#Start%20Sikuli%20Process) to start the process explicitly.
198200
You may check the detail in [issue 16](https://github.com/MarketSquare/robotframework-SikuliLibrary/issues/16)
199201
* Example:
200202
```
@@ -247,7 +249,7 @@ Setting UAC to the lowest level (not to notify the user) will reduce the instanc
247249

248250
## Differences With Other Similiar Sikuli Libraries
249251
* Robot Remote Library technology is used, different client part program languages are supported
250-
* Do not plan to expose sikuli api to Robot Framework directly. All sikuli api are encapsulated as Keywords.
252+
* Do not plan to expose SikuliX API to Robot Framework directly. All SikuliX API are encapsulated as Keywords.
251253
* Wait functionality is added for each operations
252254
```java
253255
public void click(String image) throws Exception{

docs/SikuliLibrary.html

Lines changed: 378 additions & 401 deletions
Large diffs are not rendered by default.

docs/SikuliLibrary_dark.html

Lines changed: 378 additions & 401 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)