diff --git a/README.md b/README.md index 2ee4544..ff99b5f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # Python-BPF -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. +

+ + +

+ +This is an LLVM IR generator for eBPF programs in Python. We use llvmlite to generate LLVM IR from pure Python. This is then compiled to LLVM object files, which can be loaded into the kernel for execution. We do not rely on BCC to do our compilation. + +# Installation +- Have `clang` installed. +- `pip install pythonbpf` ## Development Step 0. Make a virtual environment and activate it using `python3 -m venv .venv && source .venv/bin/activate`.