Skip to content

Commit c52fb5a

Browse files
committed
opt doc
1 parent dd4b22c commit c52fb5a

5 files changed

Lines changed: 13660 additions & 22025 deletions

File tree

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,31 @@
22

33
![ABCoder](images/ABCoder.png)
44

5-
ABCoder, an AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-coding workflow.
5+
# Overview
6+
ABCoder, an AI-oriented code-processing SDK, is designed to enhance coding context for Large-Language-Model (LLM), and boost developing AI-assisted-coding applications.
7+
68

79
## Features
810

9-
- Universal Abstract Syntax Tree (UniAST), an language-independent, AI-friendly code-struct specfication, providing flexible and structrual coding-context for both AI and hunman.
11+
- Universal Abstract Syntax Tree (UniAST), an language-independent, AI-friendly specification of code information, providing a flexible and structrual coding context for both AI and hunman.
1012

11-
- Universal Parser, parses abitary languages to UniAST.
13+
- General Parser Interface, parses abitary-language codes to UniAST.
1214

13-
- Univeral Writer, transforms UniAST back to codes.
15+
- General Writer Interface, transforms UniAST back to codes.
1416

15-
- (Comming Soon) Univeral Iterator, provides a set of interfaces and tools to help developers to implement their agents without deep knowledge of the UniAST structure.
17+
- (Comming Soon) General Iterator Interface, provides a set of functions or tools to help developers to implement their agents without deep knowledge of the UniAST structure.
1618

1719
- (Comming Soon) Code RAG, provides a set of tools to help the LLM understand your codes much deeper than ever.
1820

19-
Based on these features, developers can easily implement or enhance their AI-assisted-coding workflows (or agents), such as reviewing, optimizing, translating...
21+
Based on these features, developers can easily implement or enhance their AI-assisted-coding applications, such as reviewing, optimizing, translating...
22+
23+
24+
## Universal-Abstract-Syntax-Tree Specification
25+
26+
see [UniAST Specification](docs/uniast-zh.md)
27+
2028

21-
## Getting Started
29+
# Getting Started
2230

2331
1. Install ABCoder:
2432
```bash
@@ -34,24 +42,20 @@ abcoder parse {language} {repo-path} > ast.json
3442
abcoder write {language} ast.json
3543
```
3644

37-
## Universal-Abstract-Syntax-Tree Specification
38-
39-
see [UniAST Specification](docs/uniast-zh.md)
40-
4145

42-
## Supported Languages
46+
# Supported Languages
4347

4448
ABCoder currently supports the following languages:
4549

4650
| Language | Parser | Writer |
4751
| -------- | ----------- | ----------- |
4852
| Go |||
4953
| Rust || Coming Soon |
50-
| Kotlin | Coming Soon ||
51-
| C | WIP ||
54+
| C | Coming Soon ||
55+
5256

5357

54-
## Getting Involved
58+
# Getting Involved
5559

5660
We encourage developers to contribute and make this tool more powerful. If you are interested in contributing to ABCoder
5761
project, kindly check out our Getting Involved Guide:

0 commit comments

Comments
 (0)