From 0333886d4ff7a25acaacbbfd94dd81a2532d21b1 Mon Sep 17 00:00:00 2001 From: varun-r-mallya Date: Thu, 4 Sep 2025 10:39:47 +0530 Subject: [PATCH] Improve README documentation and setup steps --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1db8238..ea23069 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Python-BPF -This is an LLVM IR generator for eBPF program. We use `llvmlite` to generate LLVM IR code from pure Python code. This is then compiled to LLVM object files, which can be loaded into the kernel for execution. +This is an LLVM IR generator for eBPF programs in Python. We use `llvmlite` to generate LLVM IR code from pure Python code. This is then compiled to LLVM object files, which can be loaded into the kernel for execution. ## Development +Step 0. Make a virtual environment and activate it using `python3 -m venv .venv && source .venv/bin/activate`. Step 1. Run `make install` to install the required dependencies. Step 2. Run `make` to see the compilation output of the example. +Step 3. Run `check.sh` to check if generated object file passes through the verifier inside the examples directory. +Step 4. Run `make` in the `examples/c-form` directory to modify the example C BPF program to check the actual LLVM IR generated by clang. ## Authors - [@r41k0u](https://github.com/r41k0u)