Skip to content

Commit

Permalink
README: add details about build and docker use
Browse files Browse the repository at this point in the history
  • Loading branch information
ocfox committed Mar 24, 2023
1 parent aa23b6d commit 5119d8a
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ Also, this is a minimal libbpf-rs project, you can read the code to understand h
To get started, simply click the "Use this template" button on the GitHub repository page. This will create
a new repository in your account with the same files and structure as this template.

### Use docker

Run the following code and you will enter a docker environment with all the basic development dependencies and tools.

```sh
docker build -t any:any .
docker run -it any:any
# or use our image
docker run -it ghcr.io/eunomia-bpf/libbpf-rs-template:latest
```

### Build and Run

Assuming you have installed the required dependencies or are in a docker environment,
the following command will compile the sample ebpf application.

```sh
make
./target/release/runqslower
# or use cargo directly
cargo run
```

## **Features**

This starter template includes the following features:
Expand All @@ -30,6 +53,8 @@ This starter template includes the following features:

Click the "Use this template" button on the GitHub repository page to create a new repository based on this template.

If you don't want to see generate from in your repository, relax, just clone and rerun `git init`.

### **2. Clone your new repository**

Clone your newly created repository to your local machine:
Expand Down

0 comments on commit 5119d8a

Please sign in to comment.