From 385a5816c83cf23db75f88042e6df5af6e511917 Mon Sep 17 00:00:00 2001 From: wuhailong Date: Wed, 6 Sep 2023 16:02:47 +0800 Subject: [PATCH] Update README Signed-off-by: wuhailong --- README.md | 232 +------------------------------------------------- README_zh.md | 234 +-------------------------------------------------- 2 files changed, 4 insertions(+), 462 deletions(-) diff --git a/README.md b/README.md index 3df68dfee49..6e68f8fb4dc 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ For more information, see: [ARK Runtime Subsystem](https://gitee.com/openharmony ets_frontend uses the command line interaction mode and converts JS code into ARK bytecode files that can be run on an ARK runtime system. ets_frontend supports Windows, Linux, and macOS. Front-end tools, converting JS source code into ARK bytecode, can be built by specifying the `--build-target` with `ets_frontend_build` on Linux. ``` -$ ./build.sh --product-name hispark_taurus_standard --build-target ets_frontend_build +$ ./build.sh --product-name rk3568 --build-target ets_frontend_build ``` ### Usage Guidelines @@ -59,7 +59,7 @@ $ ./build.sh --product-name hispark_taurus_standard --build-target ets_frontend_ convert JS to ARK bytecode via es2abc ``` -$ cd out/hispark_taurus/clang_x64/arkcompiler/ets_frontend/ +$ cd out/rk3568/clang_x64/arkcompiler/ets_frontend/ $ ./es2abc [options] file.js ``` @@ -207,234 +207,6 @@ Specifies the path of the output file.

-#### Usage For Ts2panda #### - -Install `node` and `npm` - -convert JS to ARK bytecode - -``` -$ cd out/hispark_taurus/clang_x64/arkcompiler/ets_frontend/build -$ npm install -$ node --expose-gc src/index.js [options] file.js -``` - -If no parameter is specified for **\[options\]**, an ARK binary file is generated by default. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Option

-

Abbreviation

-

Description

-

Value Range

-

Default Value

-

--commonjs

-

-c

-

Compiles the code based on the commonjs.

-

-

-

-

-

--modules

-

-m

-

Compiles the code based on the ecmascript standard module.

-

-

-

-

-

--debug-log

-

-l

-

Enables the log function.

-

-

-

-

-

--dump-assembly

-

-a

-

Outputs an assembly file.

-

-

-

-

-

--debug

-

-d

-

Provides debug information.

-

-

-

-

-

--show-statistics

-

-s

-

Displays statistics about bytecodes.

-

-

-

-

-

--output

-

-o

-

Specifies the path of the output file.

-

-

-

-

-

--timeout

-

-t

-

Specifies the timeout threshold.

-

-

-

-

-

--opt-log-level

-

-

-

Specifies the log level for compilation optimization.

-

['debug', 'info', 'error', 'fatal']

-

error

-

--opt-level

-

-

-

Specifies the level for compilation optimization.

-

-

-

1

-

--help

-

-h

-

Displays help information.

-

-

-

-

-

--bc-version

-

-v

-

Outputs the current bytecode version.

-

-

-

-

-

--bc-min-version

-

-

-

Outputs the lowest bytecode version supported.

-

-

-

-

-

--included-files

-

-i

-

The list of dependent files

-

-

-

-

-

--record-type

-

-p

-

Record type info

-

-

-

true

-

--dts-type-record

-

-q

-

Record type info for .d.ts files

-

-

-

false

-

--debug-type

-

-g

-

Print type-related log

-

-

-

false

-

--output-type

-

-

-

Set output type

-

-

-

false

-
- For more information, please see: [ARK-Runtime-Usage-Guide](https://gitee.com/openharmony/arkcompiler_ets_runtime/blob/master/docs/README.md). diff --git a/README_zh.md b/README_zh.md index 121fc093682..54ce8487bb8 100644 --- a/README_zh.md +++ b/README_zh.md @@ -49,7 +49,7 @@ ets_frontend组件是方舟运行时子系统的前端工具，结合ace-ets2bun ets_frontend组件采用命令行交互方式，支持将JavaScript代码转换为方舟字节码文件，使其能够在方舟运行时上运行。支持Windows/Linux/MacOS平台。方舟前端工具在linux平台上可通过全量编译或指定编译前端工具链获取。 ``` -$ ./build.sh --product-name hispark_taurus_standard --build-target ets_frontend_build +$ ./build.sh --product-name rk3568 --build-target ets_frontend_build ``` ### 使用说明 @@ -59,7 +59,7 @@ $ ./build.sh --product-name hispark_taurus_standard --build-target ets_frontend_ 使用ets_frontend组件下的es2abc可执行文件将JavaScript文件转换为方舟字节码文件 ``` -$ cd out/hispark_taurus/clang_x64/arkcompiler/ets_frontend/ +$ cd out/rk3568/clang_x64/arkcompiler/ets_frontend/ $ ./es2abc [options] file.js ``` @@ -207,236 +207,6 @@ $ ./es2abc [options] file.js -#### ts2panda使用方式 #### - -安装`node`和`npm` - -使用ets_frontend组件将JavaScript文件转换为方舟字节码文件 - -``` -$ cd out/hispark_taurus/clang_x64/arkcompiler/ets_frontend/build -$ npm install -$ node --expose-gc src/index.js [options] file.js -``` - -当不输入任何option参数时，默认生成方舟二进制文件。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

选项

-

缩写

-

描述

-

取值范围

-

默认值

-

--commonjs

-

-c

-

按照commonjs模式编译

-

-

-

-

-

--modules

-

-m

-

按照ESM模式编译

-

-

-

-

-

--debug-log

-

-l

-

使能log信息

-

-

-

-

-

--dump-assembly

-

-a

-

输出为汇编文件

-

-

-

-

-

--debug

-

-d

-

携带debug信息

-

-

-

-

-

--show-statistics

-

-s

-

显示字节码相关的统计信息

-

-

-

-

-

--output

-

-o

-

输出文件路径

-

-

-

-

-

--timeout

-

-t

-

超时门限

-

-

-

-

-

--opt-log-level

-

-

-

指定编译优化log等级

-

['debug', 'info', 'error', 'fatal']

-

error

-

--opt-level

-

-

-

指定编译优化等级

-

-

-

1

-

--help

-

-h

-

帮助提示

-

-

-

-

-

--bc-version

-

-v

-

输出当前字节码版本

-

-

-

-

-

--bc-min-version

-

-

-

输出当前支持的最低字节码版本

-

-

-

-

-

--included-files

-

-i

-

编译依赖的文件列表

-

-

-

-

-

--record-type

-

-p

-

是否记录类型信息

-

-

-

true

-

--dts-type-record

-

-q

-

记录.d.ts文件的类型信息

-

-

-

false

-

--debug-type

-

-g

-

打印记录的类型信息

-

-

-

false

-

--output-type

-

-

-

设置输出类型

-

-

-

false

-
- - 更多使用说明请参考：[方舟运行时使用指南](https://gitee.com/openharmony/arkcompiler_ets_runtime/blob/master/docs/README_zh.md) ## 相关仓 -- Gitee