Skip to content

Commit 83e4094

Browse files
Update to make README factually right.
Updated README to clarify BCC dependency and reorganize example build steps.
1 parent 5654ee9 commit 83e4094

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</p>
1515

1616

17-
Python-BPF is an LLVM IR generator for eBPF programs written in Python. It uses [llvmlite](https://github.com/numba/llvmlite) to generate LLVM IR and then compiles to LLVM object files. These object files can be loaded into the kernel for execution. Unlike BCC, Python-BPF performs compilation without relying on its infrastructure.
17+
Python-BPF is an LLVM IR generator for eBPF programs written in Python. It uses [llvmlite](https://github.com/numba/llvmlite) to generate LLVM IR and then compiles to LLVM object files. These object files can be loaded into the kernel for execution. Python-BPF performs compilation without relying on BCC.
1818

1919
> **Note**: This project is under active development and not ready for production use.
2020
@@ -159,23 +159,17 @@ This architecture eliminates the need for embedding C code in Python, allowing f
159159
```bash
160160
make install
161161
```
162-
163-
3. Build and test examples:
164-
165-
```bash
166-
make
167-
```
168-
169-
4. Verify an object file with the kernel verifier:
162+
Then, run any example in `examples`
163+
3. Verify an object file with the kernel verifier:
170164

171165
```bash
172-
./check.sh check execve2.o
166+
./tools/check.sh check execve2.o
173167
```
174168

175169
5. Run an object file using `bpftool`:
176170

177171
```bash
178-
./check.sh run execve2.o
172+
./tools/check.sh run execve2.o
179173
```
180174

181175
6. Explore LLVM IR output from clang in `examples/c-form` by running `make`.

0 commit comments

Comments
 (0)