• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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`