Skip to content

Commit

Permalink
添加英文Readme (skip ci)
Browse files Browse the repository at this point in the history
  • Loading branch information
wilinz committed Jul 31, 2022
1 parent b9e29c6 commit 7941357
Show file tree
Hide file tree
Showing 3 changed files with 119 additions and 11 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/android-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ on:
workflow_dispatch:
push:
paths-ignore:
- "Readme.md"
- "README_zh_CN.md"
- "README.md"
pull_request:
paths-ignore:
- "Readme.md"
- "README_zh_CN.md"
- "README.md"

jobs:
test:
Expand Down
103 changes: 103 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Auto.js and AutoX.js
[中文文档](README_zh_CN.md)
## Introduction
A JavaScript runtime and development environment on the Android platform that supports accessibility services,
and its development goals are similar to JsBox and Workflow.

~~Since the [original author](https://github.com/hyb1996) no longer maintains the Auto.js project,
I plan to continue the maintainer project on the original basis. This project will be transferred
from [autojs](https://github.com/hyb1996/Auto.js) The project is named Autox.js. What you are looking
at is the project based on the original version 4.1. Later, I will introduce how to develop and
run the project itself. More developers are welcome to participate in the maintenance and upgrade
of this project. The latest [Autox.js Address](https://github.com/kkevsekk1/AutoX), many original project
paths in the document, I do not intend to replace them if the original project is not deleted,
to show respect for the original author. The encryption-related content in this document may
conflict with the actual operation. If you want to write code encrypted to protect intellectual
property rights, please refer to the project https:github.comkkevsekk1webpack-autojs I will gradually
improve and update the program code, keep it as much as possible Consistent.~~

This project is obtained from [hyb1996](https://github.com/hyb1996/Auto.js) autojs and named as
Autox.js (autojs modified version). What you are looking at now is the project based on the original
4.1 version. Later we will discuss how the project itself The development and operation are introduced,
and more developers are welcome to participate in the maintenance and upgrade of this project.
[Mozilla Public License Version 2.0](https://github.com/hyb1996/NoRootScriptDroid/blob/master/LICENSE.md)
adopted by [hyb1996](https://github.com/hyb1996/Auto.js) + non-commercial use, for various reasons,
this product adopts [GPL-V2 ](https://opensource.org/licenses/GPL-2.0) license, whether other contributors,
or use of this product, must be used in accordance with the relevant requirements of MPL-2.0+
non-commercial use and GPL-V2.


About the two protocols:
* GPL-V2(https://opensource.org/licenses/GPL-2.0)
* MPL-2 (https://www.mozilla.org/MPL/2.0)

### Autoxjs Now:
* Autox.js Docs: http://doc.autoxjs.com/
* Open Source Address: https://github.com/kkevsekk1/AutoX
* PC Develop: [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=aaroncheng.auto-js-vsce-fixed)
* Official Forums:[www.autoxjs.com](http://www.autoxjs.com)
* autoxjs[Changelog](CHANGELOG.md)

### Feature
1. Simple and easy-to-use automation functions implemented by accessibility services
2. Floating window recording and running
3. More professional & powerful selector API, providing search, traversal, information acquisition, operation, etc. on the controls on the screen. Similar to Google's UI testing framework UiAutomator, you can also use it as a mobile UI testing framework
4. Using JavaScript as the scripting language, and supporting functions such as code completion, variable renaming, code formatting, search and replacement, etc., it can be used as a JavaScript IDE
5. Supports the use of e 4 x to write the interface, and can package Java Script as apk file, you can use it to develop gadget applications
6. Supports the use of root privileges to provide more powerful screen tap, swipe, record and run shell commands. Recording and recording can generate js files or binary files, and the playback of recorded actions is relatively smooth
7. Provides functions such as taking screenshots, saving screenshots, finding colors in pictures, and finding pictures
8. Can be used as a Tasker plugin, combined with Tasker for daily workflow
9. With an interface analysis tool, similar to Android Studio's LayoutInspector, it can analyze the interface level and scope, and obtain the control information on the interface.


This software is different from software such as Button Wizard. The main differences are:
1. Autox.js is mainly aimed at automation and workflow, and is more convenient for daily work, such as automatically blocking notifications when starting a game, one-click WeChat video with a specific contact (this problem has occurred on Zhihu, and it is difficult for the elderly to perform complex tasks.) operation and children for WeChat video), etc.
2. Autox.js compatibility is better. Coordinate-based button sprites and script sprites are prone to resolution problems, while control-based Auto.js does not have this problem
3. Autox.js does not require root privileges to perform most tasks. Only related functions that require precise coordinates to click and slide require root privileges
4. Autox.js can provide functions such as interface writing, not only as a script software


### Autojs information
* Official Forums: [autojs.org](http://www.autojs.org)
* Docs:Online documentation is [here](https://hyb1996.github.io/AutoJs-Docs/). Documentation is still incomplete at the moment.
* Example:Some examples can be viewed [here](https://github.com/hyb1996/NoRootScriptDroid/tree/master/app/src/main/assets/sample), or viewed and run directly within the app.

### Architecture diagram
To be added, but is anyone really interested in this? Welcome to contact me to communicate

## About License
##### This product is licensed under the [GPL-V2](https://opensource.org/licenses/GPL-2.0) license
##### For historical reasons, the protocol of the [Autojs Project](https://github.com/hyb1996/Auto.js) has to be followed:

Based on the [Mozilla Public License Version 2.0](https://github.com/hyb1996/NoRootScriptDroid/blob/master/LICENSE.md)
with the following terms: Non-Commercial Use - The source code and binary products of this project and its derived projects may not be used for any commercial or for-profit use

#### Code contributors need to take note:

No one in the original text states that the license is MPL2.0, and the newly added files or modified
(only for repairing your own) code adopts GPL-V2, and relevant declarations are required.
``` java
// SPDX-License-Identifier: GPL-2.0
// Claim your copyright
```
#### Others use Autox.js, please pay attention to in-depth development
* If you use GPL-2.0 declared code or compiled binaries. You need to open source all your code.
* If you only use MPL-2.0 stuff, you need to open source the relevant code you modified.
#### Aside from this product, talk about open source and business
* Open source does not mean free use, and open source does not mean prohibiting commercial use!
* Open source things can be commercialized, but you need to open source according to the regulations!
* Commercial products can be open source, such as redhat!
* If you do not use open source products according to the open source agreement, you can understand the source of openwrt and the domestic infringement cases in recent years!

#### For js scripts developed by other people, run it on this. Does it need to follow GPL-2.0 for open source
* That is your freedom, not restricted by this agreement, just like linux runs software

#### Is it possible to use this product or autojs product for commercial use?
* Whether this product can be used for commercial use depends on the original autojs, because many functions and codes are copyrighted by autojs.
* Whether autojs can be commercialized depends on your understanding of the accompanying "non-commercial use" and its legal benefits.
* Anyway, this product will not use autojs for commercial use.

#### Support
* If you want to support project contributors, you can do this by
* [wilinz](https://github.com/wilinz/Sponsor)

21 changes: 12 additions & 9 deletions Readme.md → README_zh_CN.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Auto.js 和 AutoX.js
# Auto.js And Autox.js

[English Document](README.md)

## 简介
一个支持无障碍服务的Android平台上的JavaScript 运行环境 和 开发环境,其发展目标是类似JsBox和Workflow。

~~由于[原作者](https://github.com/hyb1996/Auto.js) 不再维护 Auto.js 项目
我计划在原来基础上继续维护者项目,本项目从[autojs](https://github.com/hyb1996/Auto.js) 并将原项目命名为AutoX.js。
~~由于[原作者](https://github.com/hyb1996) 不再维护 Auto.js 项目
我计划在原来基础上继续维护者项目,本项目从[autojs](https://github.com/hyb1996/Auto.js) 并将原项目命名为Autox.js。
你现在看的是原4.1版基础上的项目,后面我将针对项目本身如何开发、运行的进行介绍,欢迎更多开发者参与这个项目维护升级,
最新的[AutoX地址](https://github.com/kkevsekk1/AutoX), 文档中很多原项目路径,
最新的[Autox.js地址](https://github.com/kkevsekk1/AutoX), 文档中很多原项目路径,
在原项目没有删除的情况下我并不打算替换掉,以表对于原作者的尊重。这篇文档里有加密相关的内容可能和实际运行情况有冲突,
如果你希望写的代码加密保护知识产权,请参考项目 https://github.com/kkevsekk1/webpack-autojs
我会逐步完善更新,程序代码,尽可能保持一致。~~

本项目从[hyb1996](https://github.com/hyb1996/Auto.js) autojs 获得,并命名为AutoX.js (autojs 修改版本), 你现在看的是原4.1版本基础上的项目,
本项目从[hyb1996](https://github.com/hyb1996/Auto.js) autojs 获得,并命名为Autox.js (autojs 修改版本), 你现在看的是原4.1版本基础上的项目,
后面我们将针对项目本身如何开发、运行的进行介绍,欢迎更多开发者参与这个项目维护升级。[hyb1996](https://github.com/hyb1996/Auto.js)采用的
[Mozilla Public License Version 2.0](https://github.com/hyb1996/NoRootScriptDroid/blob/master/LICENSE.md) +**非商业性使用**,出于多种因素考虑,
本产品采用 [GPL-V2](https://opensource.org/licenses/GPL-2.0) 许可证, 无论是其他贡献者,还是使用该产品,均需按照 MPL-2.0+非商业性使用 和 GPL-V2 的相关要求使用。
Expand All @@ -20,8 +23,8 @@
* GPL-V2(https://opensource.org/licenses/GPL-2.0)
* MPL-2 (https://www.mozilla.org/MPL/2.0)

### 现在AutoXjs
* AutoX.js文档: http://doc.autoxjs.com/
### 现在的Autox.js
* Autox.js文档: http://doc.autoxjs.com/
* 开源地址 https://github.com/kkevsekk1/AutoX
* pc端开发[VS Code 插件](https://marketplace.visualstudio.com/items?itemName=aaroncheng.auto-js-vsce-fixed)
* 官方论坛: [www.autoxjs.com](http://www.autoxjs.com)
Expand Down Expand Up @@ -61,7 +64,7 @@
基于[Mozilla Public License Version 2.0](https://github.com/hyb1996/NoRootScriptDroid/blob/master/LICENSE.md)并附加以下条款:
* **非商业性使用** — 不得将此项目及其衍生的项目的源代码和二进制产品用于任何商业和盈利用途

#### 本AutoXjs能不能采用GPL-V2?
#### 本Autox.js能不能采用GPL-V2?

关于GPL-V2 应该很容易理解, 著名linux 采用该许可证。但是对于MPL-2.0 有非常多的文章都是停留在MPL-1.1 的版本,对非常多国内开发者造成困扰,
这是一篇比较标准[译文](https://github.com/rachelzhang1/MPL2.0_zh-CN/blob/93d2feec60d8b0b5a54a1843c866994af4610d4f/Mozilla_Public_License_2.0_Simplified_Chinese_Reference.txt)
Expand All @@ -74,7 +77,7 @@
// SPDX-License-Identifier: GPL-2.0
// 申明你的版权
```
#### 其他人使用AutoXjs,做深度开发请注意
#### 其他人使用Autox.js,做深度开发请注意
* 如果你使用了带有GPL-2.0 声明的代码 或编译出来的二进制。你需要开源你所有代码。
* 如果你仅使用了MPL-2.0 的东西,你需要开源你修改过的相关代码。
#### 抛开本产品谈 开源和商业
Expand Down

0 comments on commit 7941357

Please sign in to comment.