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

PR for README.md english version #104

Merged
merged 11 commits into from
Sep 25, 2019
Merged

PR for README.md english version #104

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
630257e
Add new file README_eng.md
ruoranw Sep 7, 2019
6a50224
Finish the 1st feature which is real time recording.
ruoranw Sep 11, 2019
6f33683
Finish the 2nd feature.
ruoranw Sep 12, 2019
58eab70
finish the 3rd feature.
ruoranw Sep 13, 2019
de6c964
finish getting started.
ruoranw Sep 19, 2019
783597c
finish getting started.
ruoranw Sep 24, 2019
1022e82
finish content
ruoranw Sep 25, 2019
b15217a
add directory.
ruoranw Sep 25, 2019
6ba8668
Add line breaks at the directory.
ruoranw Sep 25, 2019
06f5147
change texts in directory with bigger fonts.
ruoranw Sep 25, 2019
5fda4eb
function name, some word meanings.
soloPi Sep 25, 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
Prev Previous commit
Next Next commit
add directory.
  • Loading branch information
@ruoranw
ruoranw committed Sep 25, 2019
commit b15217abe766171f0f6345ab15a606dcccf86d1d
55 changes: 19 additions & 36 deletions README_eng.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,24 @@

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

## Features
[Features](#1)
[Getting started](#2)
[Folders and description](#3)
[Contributing](#4)
[Attributions](#5)
[License](#6)
[Disclaimer](#7)


## <span id="1">Features</span>

### 1. Real time recording

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.

![Recording playback](assets/replay.gif)

The tutorial video:
The video tutorial:

**[Record the testing on a video game.](https://gw.alipayobjects.com/mdn/rms_e29b5f/afts/file/A*ym07T6nACDIAAAAAAAAAAABkARQnAQ)**

Expand All @@ -29,7 +38,7 @@ The tutorial video:

![Performance analysis](assets/performance.gif)

The tutorial video:
The video tutorial:

**[Use the performance analysis function](https://gw.alipayobjects.com/os/basement_prod/1996390b-9ec8-4046-8ce8-459afa05d6c5.mov)**

Expand All @@ -41,11 +50,11 @@ SoloPi supports simultaneous multi-device testing which is controlled by one dev

![Multi-device testing](assets/oneToMany.gif)

The tutorial video:
The video tutorial:

**[Simultaneous multi-device testing](https://gw.alipayobjects.com/os/basement_prod/971b5467-3db0-4781-86e3-15b3907323f6.mov)**

## Getting started
## <span id="2">Getting started</span>

> Open source SoloPi excludes the multi-device testing feature since it's still unstable.

Expand Down Expand Up @@ -142,7 +151,7 @@ macOS/Linux：

You can either download SoloPi.apk or clone the repository.

## Folders and description
## <span id="3">Folders and description</span>
In the folder src,
- app: The business logic of the application.
- shared: The core function of the application.
Expand All @@ -152,17 +161,17 @@ In the folder src,
- AdbLib: ADB connection.
- androidWebscoket: Android WebSocket.

## Contributing
## <span id="4">Contributing</span>

This project is mainly open to developers who want to do software testing. If you have any suggestions or questions, you can open an issue, send a PR, or leave a message at our page at [TesterHome](https://testerhome.com/topics/node152).

If you like our project, please fork/⭐Star this project!

## Attributions
## <span id="5">Attributions</span>

We want to thank those [third party libraries](https://github.com/ruoranw/SoloPi/blob/master/NOTICE.md) used in this project without which this project couldn't be completed.

## License
## <span id="6">License</span>

This project is under the Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.

Expand All @@ -183,36 +192,10 @@ limitations under the License.
```


## Disclaimer
## <span id="7">Disclaimer</span>

[Disclaimer](Disclaimer.md)