Skip to content

Commit

Permalink
Update README.md to note requirement for submodule initialization (#262)
Browse files Browse the repository at this point in the history
Signed-off-by: Will Hawkins <hawkinsw@obs.cr>
Co-authored-by: Alan Jowett <alanjo@microsoft.com>
  • Loading branch information
hawkinsw and Alan-Jowett committed May 22, 2023
1 parent 2249c83 commit f8d06bb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -18,6 +18,17 @@ This project aims to create an Apache-licensed library for executing eBPF progra
This project includes an eBPF assembler, disassembler, interpreter (for all platforms),
and JIT compiler (for x86-64 and Arm64 targets).

## Checking Out

Before following any of the instructions below for [building](#building-with-cmake),
[testing](#running-the-tests), [contributing](#contributing), etc, please be
sure to properly check out the source code which requires properly initializing submodules:

```
git submodule init
git submodule update --recursive
```

## Building with CMake
Note: This works on Windows, Linux, and MacOS, provided the prerequisites are installed.
```
Expand Down

0 comments on commit f8d06bb

Please sign in to comment.