From 83e4094ca9ba09773519540383cf7b01238c8224 Mon Sep 17 00:00:00 2001 From: varunrmallya <100590632+varun-r-mallya@users.noreply.github.com> Date: Wed, 1 Oct 2025 01:27:17 +0530 Subject: [PATCH] Update to make README factually right. Updated README to clarify BCC dependency and reorganize example build steps. --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index ee33dc6..aac2527 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@

-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. +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. > **Note**: This project is under active development and not ready for production use. @@ -159,23 +159,17 @@ This architecture eliminates the need for embedding C code in Python, allowing f ```bash make install ``` - -3. Build and test examples: + Then, run any example in `examples` +3. Verify an object file with the kernel verifier: ```bash - make - ``` - -4. Verify an object file with the kernel verifier: - - ```bash - ./check.sh check execve2.o + ./tools/check.sh check execve2.o ``` 5. Run an object file using `bpftool`: ```bash - ./check.sh run execve2.o + ./tools/check.sh run execve2.o ``` 6. Explore LLVM IR output from clang in `examples/c-form` by running `make`.