Skip to content

Commit 9a90d16

Browse files
authored
docs: clarify llgo main-branch install requirements (#655)
* docs: update README for llgo-main pipeline and debug tools * docs: update install guide for llgo main pipeline * docs: remove cjson package install from README * docs: restore opening wording and mention llgo pipeline
1 parent 136f197 commit 9a90d16

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,30 @@ llcppg - LLGo autogen tool for C/C++ libraries
88
[![Language](https://img.shields.io/badge/language-XGo-blue.svg)](https://github.com/goplus/gop)
99
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/goplus/llcppg)
1010

11-
llcppg aims to be a tool for automatically generating LLGo bindings for C/C++ libraries, enhancing the experience of integrating LLGo with C! It is worth mentioning that several core components of llcppg are built using LLGo, fully leveraging its core capability of "better integrating with the C ecosystem" for development.
11+
llcppg aims to be a tool for automatically generating LLGo bindings for C/C++ libraries, enhancing the experience of integrating LLGo with C!
12+
It is worth mentioning that the full llcppg package-generation pipeline is now built and orchestrated with LLGo.
1213

1314
## How to install
1415

15-
This project depends on LLGo's C ecosystem integration capability, and some components of this tool must be compiled with LLGo. For LLGo installation, please refer to:
16+
This project depends on LLGo's C ecosystem integration capability, and the current end-to-end llcppg package-generation pipeline is fully compiled by LLGo.
17+
llcppg currently follows the latest LLGo main-branch behavior. Please build and install LLGo from the `main` branch first, then install llcppg.
18+
19+
For LLGo installation, please refer to:
1620
https://github.com/goplus/llgo?tab=readme-ov-file#how-to-install
1721

1822
```bash
19-
brew install cjson # macos
20-
apt-get install libcjson-dev # linux
23+
llgo install ./cmd/llcppg
24+
25+
# Optional debug / troubleshooting tools:
2126
llgo install ./_xtool/llcppsymg
2227
llgo install ./_xtool/llcppsigfetch
28+
llgo install ./cmd/gogensig
2329
go install ./cmd/llcppcfg
24-
llgo install -v ./cmd/gogensig
25-
go install -v ./cmd/llcppg
2630
```
2731

32+
For normal package generation, only the `llcppg` binary is required.
33+
The standalone tools above are kept mainly for debugging and isolated troubleshooting.
34+
2835

2936
## Usage
3037

0 commit comments

Comments
 (0)