Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #554

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b99192
Update README.md
SurajKumarM98 Oct 12, 2019
0fb559d
Update README.md
SurajKumarM98 Oct 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@

## Features

* **Write Once, Run Anywhere:** Airtest provides cross-platform APIs, including app installation, simulated input, assertion and so forth. Airtest uses image recognition technology to locate UI elements, so that you can automate games and apps without injecting any code.
* **Write Once, Run Anywhere:** Airtest provides cross-platform APIs, including app installation, simulated input, assertion and so forth. Airtest uses image recognition technology to locate UI elements so that you can automate games and apps without injecting any code.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the comma makes the sentence too long. Is it necessary to remove it?

Copy link
Author

@SurajKumarM98 SurajKumarM98 Oct 17, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is necessary; because its improper to have a comma in that place.
Its not of much significance so its upto you to decide whether to consider it or not.


* **Fully Scalable:** Airtest cases can be easily run on large device farms, using commandline or python API. HTML reports with detailed info and screen recording allow you to quickly locate failure points. NetEase builds [Airlab](https://airlab.163.com/) on top of Airtest Project.
* **Fully Scalable:** Airtest cases can be easily run on large device farms, using commandline or python API. HTML reports with detailed info and screen recording allow you to quickly locate failure points. NetEase builds [Airlab](https://airlab.163.com/) on top of the Airtest Project.

* **AirtestIDE:** AirtestIDE is an out of the box GUI tool that helps to create and run cases in a user-friendly way. AirtestIDE supports a complete automation workflow: ``create -> run -> report``.

* **Poco:** [Poco](https://github.com/AirtestProject/Poco) adds the ability to directly access object(UI widget) hierarchy across the major platforms and game engines. it allows writing instructions in Python, to achieve more advanced automation.
* **Poco:** [Poco](https://github.com/AirtestProject/Poco) adds the ability to directly access object(UI widget) hierarchy across the major platforms and game engines. It allows writing instructions in Python, to achieve more advanced automation.

Get started from [airtest homepage](http://airtest.netease.com/)

Expand All @@ -28,13 +28,13 @@ Get started from [airtest homepage](http://airtest.netease.com/)

## Installation

Use `pip` to install Airtest python library.
Use `pip` to install the Airtest python library.

```Shell
pip install -U airtest
```

On MacOS/Linux platform, you need to grant adb execute permission.
On the macOS/Linux platform, you need to grant adb execute permission.

```Shell
# for mac
Expand All @@ -54,7 +54,7 @@ You can find the complete Airtest documentation on [readthedocs](http://airtest.

## Examples

Airtest aims at providing platform independent API, so that you can write automated cases once and run it on multiple devices and platforms.
Airtest aims at providing platform-independent API so that you can write automated cases once and run it on multiple devices and platforms.

1. Using [connect_device](http://airtest.readthedocs.io/en/latest/README_MORE.html#connect-device) API you can connect to any android/iOS device or windows application.
1. Then perform [simulated input](http://airtest.readthedocs.io/en/latest/README_MORE.html#simulate-input) to automate your game or app.
Expand Down Expand Up @@ -84,7 +84,7 @@ For more detailed info, please refer to [Airtest Python API reference](http://ai
## Running ``.air`` cases from CLI

Using AirtestIDE, you can easily create automated cases as ``.air`` directories.
Airtest CLI provides the possibility to execute cases on different host machine and target device platforms without using AirtestIDE itself.
Airtest CLI provides the possibility to execute cases on different host machines and target device platforms without using AirtestIDE itself.

```Shell
# run cases targeting on Android phone connected to your host machine via ADB
Expand All @@ -96,7 +96,7 @@ airtest run "path to your .air dir" --device "Windows:///?title_re=Unity.*"
# generate HTML report after running cases
airtest report "path to your .air dir"

# or use as python module
# or use as a python module
python -m airtest run "path to your .air dir" --device Android:///
```

Expand Down