From 6374bd666da34b8a91ec861356c10dd5c801fdb2 Mon Sep 17 00:00:00 2001 From: Han00000000 Date: Sat, 11 Sep 2021 17:30:26 +0800 Subject: [PATCH] fix docs issues Signed-off-by: Han00000000 Change-Id: Ic8f13d3606258504540831b6af4ce6431121f3a8 --- README.md | 30 ++++++++++++++++-------------- README_zh.md | 28 +++++++++++++++------------- 2 files changed, 31 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 056e1a5640..45229bb42b 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,31 @@ # ts2abc -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Note](#section0446154755015) - - [Usage Guidelines](#section33105542504) - -- [Repositories Involved](#section1371113476307) +- [ts2abc ](#ts2abc-) + - [Introduction](#introduction) + - [Directory Structure](#directory-structure) + - [Note](#note) + - [Usage Guidelines](#usage-guidelines) + - [Repositories Involved](#repositories-involved) ## Introduction -As a module of the ARK platform, ts2abc is a front-end tool for JavaScript \(JS\) in the ARK compiler. It converts JS files into ARK bytecode files. +ts2abc is a front-end tool in the ARK Runtime Subsystem. It converts JavaScript(JS) files into ARK bytecode files. + +For more infomation, see: [ARK Runtime Subsystem](https://gitee.com/openharmony/docs/blob/master/en/readme/ARK-Runtime-Subsystem.md). ## Directory Structure ``` /ark/ts2abc/ +├── test262 # scripts for configuration and running Test262 ├── ts2panda - ├── doc # Documents ├── scripts # Dependency scripts ├── src # Source code directory ├── templates # Ruby templates ├── tests # Unit test cases ├── tools # Tools provided by ts2abc └── ts2abc # ts2abc source code + ``` ## Note @@ -181,13 +184,12 @@ You can run **node --expose-gc _your\_path_\_to/index.js \[options\] _your\_f -## Repositories Involved - -[ARK Runtime Subsystem](https://gitee.com/openharmony/ark_js_runtime/blob/master/docs/ARK-Runtime-Subsystem.md) +For more infomation, please see: [ARK-Runtime-Usage-Guide](https://gitee.com/openharmony/ark_js_runtime/blob/master/docs/ARK-Runtime-Usage-Guide.md). -[ark/runtime\_core](https://gitee.com/openharmony/ark_runtime_core/blob/master/README.md) +## Repositories Involved -[ark/js\_runtime](https://gitee.com/openharmony/ark_js_runtime/blob/master/README.md) +[ark\_runtime\_core](https://gitee.com/openharmony/ark_runtime_core) -**[ark/ts2abc](README.md)** +[ark\_js\_runtime](https://gitee.com/openharmony/ark_js_runtime) +**[ark\_ts2abc](https://gitee.com/openharmony/ark_ts2abc)** diff --git a/README_zh.md b/README_zh.md index 4955793979..8bf1d569e9 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,20 +1,23 @@ # ts2abc组件 -- [简介](#section11660541593) -- [目录](#section161941989596) -- [说明](#section0446154755015) - - [使用说明](#section33105542504) - -- [相关仓](#section1371113476307) +- [ts2abc组件](#ts2abc组件) + - [简介](#简介) + - [目录](#目录) + - [说明](#说明) + - [使用说明](#使用说明) + - [相关仓](#相关仓) ## 简介 -ts2abc组件是方舟平台的一个组件，其作为方舟编译器中JavaScript语言的前端工具，支持将JavaScript文件转换为方舟字节码文件。 +ts2abc组件是方舟运行时子系统的前端工具，支持将JavaScript文件转换为方舟字节码文件。 + +更多信息请参考：[方舟运行时子系统](https://gitee.com/openharmony/docs/blob/master/zh-cn/readme/ARK-Runtime-Subsystem-zh.md) ## 目录 ``` /ark/ts2abc/ +├── test262 # Test262测试配置和运行脚本 ├── ts2panda ├── doc # 文档 ├── scripts # 依赖的脚本 @@ -181,13 +184,12 @@ ts2abc组件将JavaScript文件转换为方舟字节码文件，命令行格式 -## 相关仓 +更多使用说明请参考：[方舟运行时使用指南](https://gitee.com/openharmony/ark_js_runtime/blob/master/docs/ARK-Runtime-Usage-Guide-zh.md) -[方舟运行时子系统](https://gitee.com/openharmony/ark_js_runtime/blob/master/docs/ARK-Runtime-Subsystem-zh.md) - -[ark/runtime\_core](https://gitee.com/openharmony/ark_runtime_core/blob/master/README_zh.md) +## 相关仓 -[ark/js\_runtime](https://gitee.com/openharmony/ark_js_runtime/blob/master/README_zh.md) +[ark\_runtime\_core](https://gitee.com/openharmony/ark_runtime_core) -**[ark/ts2abc](README_zh.md)** +[ark\_js\_runtime](https://gitee.com/openharmony/ark_js_runtime) +**[ark\_ts2abc](https://gitee.com/openharmony/ark_ts2abc)** -- Gitee