• Home
Name Date Size #Lines LOC

..--

abckit/22-Oct-2025-161125

doc/22-Oct-2025-1,6621,251

include/22-Oct-2025-21,0037,104

scripts/22-Oct-2025-2,3201,752

src/22-Oct-2025-35,46627,746

tests/22-Oct-2025-84,37961,056

.clang-formatD22-Oct-20253.8 KiB128126

.clang-tidyD22-Oct-20255.8 KiB157155

.doxygenD22-Oct-2025107.1 KiB2,5802,009

BUILD.gnD22-Oct-20254.8 KiB186160

README.mdD22-Oct-20251.1 KiB5238

README_zh.mdD22-Oct-20251.1 KiB5438

abckit_config.gniD22-Oct-2025892 2421

eslint.config.jsD22-Oct-20251.2 KiB4125

package.jsonD22-Oct-2025434 2120

README.md

1# AbcKit
2
3[简体中文](README_zh.md)
4
5AbcKit is a library for `abc` file inspection and modification.
6
7Documentation:
8
9- [How to build and test](doc/how_to_build_and_test.md)
10- [Cook Book](doc/mini_cookbook.md)
11- [Implementation description](doc/implementation_description.md)
12
13## How to download and build
14
15AbcKit should be built on Linux.
16
17### Install dependencies:
18
19Ensure the following components are installed:
20- repo
21- clang++-14
22- clang-format-14
23- clang-tidy-14
24- doxygen
25- graphviz
26- Git LFS
27
28### Download:
29
30```sh
31repo init -u https://gitee.com/ark-standalone-build/manifest.git -b master
32repo sync -c -j8
33repo forall -c 'git lfs pull'
34./prebuilts_download.sh
35```
36
37### Build AbcKit:
38
39```sh
40# Linux Version
41./ark.py x64.release abckit_packages --gn-args="is_standard_system=true abckit_enable=true"
42# Windows Version
43./ark.py mingw_x86_64.release abckit_packages --gn-args="is_standard_system=true abckit_enable=true"
44```
45
46### Generate doxygen documentation
47```sh
48cd out/x64.release
49ninja abckit_documentation
50```
51
52See generated documentation in `out/x64.release/gen/arkcompiler/runtime_core/libabckit/doxygen`

README_zh.md

1# AbcKit
2
3`AbcKit` 是一个用于**检查和修改**方舟字节码的工具库。
4
5文档索引：
6
7- [如何构建与测试](doc/how_to_build_and_test_zh.md)
8- [快速上手小册](doc/mini_cookbook_zh.md)
9- [实现原理说明](doc/implementation_description_zh.md)
10
11---
12
13## 如何下载与构建
14
15AbcKit 需要在 Linux 环境下构建。
16
17### 安装依赖项:
18
19请确保已安装以下组件：
20
21- `repo`
22- `Clang++-14`
23- `Clang-format-14`
24- `Clang-tidy-14`
25- `Doxygen`
26- `Graphviz`
27- `Git LFS`
28
29### 下载代码:
30
31```sh
32repo init -u https://gitee.com/ark-standalone-build/manifest.git -b master
33repo sync -c -j8
34repo forall -c 'git lfs pull'
35./prebuilts_download.sh
36```
37
38### 构建 AbcKit:
39
40```sh
41# Linux 平台构建
42./ark.py x64.release abckit_packages --gn-args="is_standard_system=true abckit_enable=true"
43# Windows 平台构建
44./ark.py mingw_x86_64.release abckit_packages --gn-args="is_standard_system=true abckit_enable=true"
45```
46
47### 生成 Doxygen 文档:
48
49```sh
50cd out/x64.release
51ninja abckit_documentation
52```
53
54生成的文档将保存在 `out/x64.release/gen/arkcompiler/runtime_core/libabckit/doxygen`