diff --git a/README_eng.md b/README_eng.md index b598552..1e07089 100644 --- a/README_eng.md +++ b/README_eng.md @@ -2,7 +2,7 @@ [![GitHub stars](https://img.shields.io/github/stars/soloPi/SoloPi.svg)](https://github.com/soloPi/SoloPi/stargazers) [![GitHub license](https://img.shields.io/github/license/soloPi/SoloPi.svg)](https://github.com/soloPi/SoloPi/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/alipay/SoloPi.svg)](https://github.com/soloPi/SoloPi/releases) [![API](https://img.shields.io/badge/API-18%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=18) [![TesterHome](https://img.shields.io/badge/TTF-TesterHome-2955C5.svg)](https://testerhome.com/opensource_projects/82) -> SoloPi is a wireless, non-invasive testing tool for automatic Android software testing. The Beta version has 3 main features: real time recording, performance data analysis, convenient multi-device testing. +> SoloPi is a wireless, non-invasive testing tool for automatic Android software testing. The Beta version has 3 main features: record and replay, performance testing, multi-device compatibility testing(OneToMany). ### [Features](#1)
### [Getting started](#2)
@@ -15,7 +15,7 @@ ## Features -### 1. Real time recording +### 1. Record and replay SoloPi captures all actions performed during tesing sessions so that issues can be identified and resolved more quickly. The recording can be played on any devices. All these actions can be done on just one single phone. @@ -23,12 +23,12 @@ SoloPi captures all actions performed during tesing sessions so that issues can The video tutorial: -**[Record the testing on a video game.](https://gw.alipayobjects.com/mdn/rms_e29b5f/afts/file/A*ym07T6nACDIAAAAAAAAAAABkARQnAQ)** +**[Record the testing on a mobile game.](https://gw.alipayobjects.com/mdn/rms_e29b5f/afts/file/A*ym07T6nACDIAAAAAAAAAAABkARQnAQ)** **[Record the testing on a native phone app.](https://gw.alipayobjects.com/os/basement_prod/3472d35c-bd57-4c82-8112-5dcde42fcb32.mov)** -### 2. Real time performance analysis +### 2. Performance testing * SoloPi is able to record and show the app's performance data such as CPU, memory, internet speed while do the testing. The performance window with selected testing metrics will float on top. After testing, you can check each testing parameter with generated data graphs. @@ -44,9 +44,9 @@ The video tutorial: **[Use the launch time calculator](https://gw.alipayobjects.com/os/basement_prod/4e82ca85-13fc-4de2-82ff-a9079344f5ef.mov)** -### 3. Multi-device testing +### 3. Multi-device compatibility testing -SoloPi supports simultaneous multi-device testing which is controlled by one device. So it enormously improves the efficiency of testing on different devices. +SoloPi supports simultaneous multi-device compatibility testing which is controlled by one device. So it enormously improves the efficiency of testing on different devices. ![Multi-device testing](assets/oneToMany.gif) @@ -56,17 +56,18 @@ The video tutorial: ## Getting started -> Open source SoloPi excludes the multi-device testing feature since it's still unstable. +> Open source SoloPi excludes the multi-device compatibility testing feature since it's still unstable. ### 1. Establishing a build environment - macOS 10.14.3 - Android Studio 3.2 - **Gradle 4.4（Upgrading is not recommended.）** +- **CMake 3.6.4111459（Upgrading is not recommended.）** - Ndk 15.2.4203819 - TargetApi 25 - MinimumApi 18 -- **Note: Turn off instant run function in Android Studio. Otherwise the finished installing package of the app does not work.** +- **Note: Turn off instant run function in Android Studio. Otherwise the app does not work.** ### 2. Downloading and setting Android SDK path @@ -89,7 +90,7 @@ For system above Windows 10, it takes effect immediately in a new command line w - For VIVO devices, if there’s an option like ‘USB security access’ under developer options, it needs to be toggled on, otherwise recording and multi-device testing function may not work. -- For Xiaomi devices, under developer options, USB installation and USB debugging also need to be toggled on. Besides, you also need to turn on ‘后台弹出界面’ under ‘应用权限’ menu in SoloPi. +- For Xiaomi devices, under developer options, USB installation and USB debugging also need to be toggled on. Besides, you also need to turn on ‘后台弹出界面’ permission of SoloPi (System Settings -> App Management -> SoloPi -> Permissions). - For MEIZU devices, if the application to be tested contains highly secured functions like payment function, the secure payment function in the system needs to be turned off. @@ -97,6 +98,8 @@ For system above Windows 10, it takes effect immediately in a new command line w - For OPPO devices, system would ‘unchecking’ the ‘USB debugging’ every 10 minutes, leading to the unavailability of SoloPi. To solve it, keep connecting the phone to the computer. +- **It's highy recommandded to turn off safety input method in system language settings (if it has), otherwise text input may not work when input password or something else.** + ### 5. Debugging apps over Wi-Fi #### 5.1 Connect the device to PC via USB and make sure debugging is working. @@ -105,10 +108,12 @@ When the device is connected to the PC, the device should pop up 'Allow USB debu Check if the connection is successful in command line: -Windows: ```bash +Windows: +```bash %ANDROID_SDK%\platform-tools\adb.exe devices ``` -MacOS/Linux: ```shell +MacOS/Linux: +```shell $ANDROID_SDK/platform-tools/adb devices ``` @@ -122,11 +127,13 @@ If it returns with the device number, then the connection is successful. For single device, -Windows: ```bash +Windows: +```bash %ANDROID_SDK%\platform-tools\adb.exe tcpip 5555 ``` -macOS/Linux：```shell +macOS/Linux： +```shell $ANDROID_SDK/platform-tools/adb tcpip 5555 ```