From 6412dfff0a06c5cb95d3393ece7c39906973fbeb Mon Sep 17 00:00:00 2001 From: shining Date: Thu, 20 Feb 2020 12:19:11 +0800 Subject: [PATCH] Clean the format of Developer_Guide This patch clean the format of Developer_Guide, both the cn version and en version. This patch will make the doc more clearly and more readable. --- doc/cn/Developer_Guide.md | 29 ++++++++++++++++------------- doc/en/Developer_Guide.md | 21 ++++++++++++--------- 2 files changed, 28 insertions(+), 22 deletions(-) diff --git a/doc/cn/Developer_Guide.md b/doc/cn/Developer_Guide.md index 10841c8e3e..7a07e51494 100644 --- a/doc/cn/Developer_Guide.md +++ b/doc/cn/Developer_Guide.md @@ -9,8 +9,8 @@ ## 源码下载 - 下载地址：，可以通过`Clone` or `Download`的方式下载openarkcompiler源码 - > 注：默认源码下载目录为openarkcompiler + 下载地址：，可以通过`Clone` or `Download`的方式下载openarkcompiler源码。 + > 注：默认源码下载目录为openarkcompiler。 ## 源码编译 @@ -24,9 +24,9 @@ make ``` 命令说明： -- `source build/envsetup.sh` 初始化环境，将OpenArkCompiler工具链路径openarkcompiler/out/bin设置到环境变量中 -- `make` 编译OpenArkCompiler的Release版本 -- `make BUILD_TYPE=DEBUG` 编译OpenArkCompiler的Debug版本 +- `source build/envsetup.sh` 初始化环境，将OpenArkCompiler工具链路径openarkcompiler/out/bin设置到环境变量中； +- `make` 编译OpenArkCompiler的Release版本； +- `make BUILD_TYPE=DEBUG` 编译OpenArkCompiler的Debug版本。 ## Sample示例编译 @@ -36,19 +36,19 @@ make - 您可以自己下载Android代码本地编译来获得libcore的jar包，建议使用Android的9.0.0_r45版本； -- 同时码云上也提供了已经编译好的libcore的jar文件，你可以下载直接使用，下载链接：https://gitee.com/mirrors/java-core/ +- 同时码云上也提供了已经编译好的libcore的jar文件，你可以下载直接使用，下载链接：https://gitee.com/mirrors/java-core/ 。 **生成libjava-core.mplt文件** 编译前，请先在openarkcompiler目录下创建libjava-core目录，拷贝java-core.jar到此目录下，在openarkcompiler目录执行以下命令： - + ``` -source build/envsetup.sh; -make; -cd libjava-core; -jbc2mpl -injar java-core.jar -out libjava-core; +source build/envsetup.sh +make +cd libjava-core +jbc2mpl -injar java-core.jar -out libjava-core ``` - + 执行完成后会在此目录下生成libjava-core.mplt文件。 **示例代码快速编译** @@ -58,7 +58,10 @@ jbc2mpl -injar java-core.jar -out libjava-core; 以samples/helloworld/代码为例，在openarkcompiler/目录下执行以下命令： ``` -source build/envsetup.sh; make; cd samples/helloworld/; make +source build/envsetup.sh +make +cd samples/helloworld/ +make ``` ## 源码静态检查 diff --git a/doc/en/Developer_Guide.md b/doc/en/Developer_Guide.md index 23b347280c..b366eb323d 100644 --- a/doc/en/Developer_Guide.md +++ b/doc/en/Developer_Guide.md @@ -9,7 +9,7 @@ Prepare development environment by referring to Environment Configuration. ## Downloading Source Code -Download address: +Download address: . You can download the OpenArkCompiler source code in `Clone` or `Download` mode. > Note: The download directory of the source code is openarkcompiler by default. @@ -37,19 +37,19 @@ The Java basic library is required for OpenArkCompiler to compile a sample. The - Download the Android code and compile it locally to obtain the libcore JAR package. The Android 9.0.0_r45 version is recommended. -- Gitee also provides the compiled libcore JAR file. Download address: https://gitee.com/mirrors/java-core/ +- Gitee also provides the compiled libcore JAR file. Download address: https://gitee.com/mirrors/java-core/ . **Generating the libjava-core.mplt file** Before compilation, create the libjava-core directory in the openarkcompiler directory, copy the java-core.jar file to the libjava-core directory, and run the following commands in the openarkcompiler directory: - + ``` -source build/envsetup.sh; -make; -cd libjava-core; -jbc2mpl -injar java-core.jar -out libjava-core; +source build/envsetup.sh +make +cd libjava-core +jbc2mpl -injar java-core.jar -out libjava-core ``` - + After the execution is complete, the libjava-core.mplt file is generated in the directory. **Compiling sample code** @@ -59,5 +59,8 @@ The sample code is in the openarkcompiler/samples directory. Take the samples/helloworld/ code as an example. Run the following command in the openarkcompiler/ directory: ``` -source build/envsetup.sh; make; cd samples/helloworld/; make +source build/envsetup.sh +make +cd samples/helloworld/ +make ``` -- Gitee