From 8d094935af4e79e7883e1012d2381f3b000b8c21 Mon Sep 17 00:00:00 2001 From: Eric Ernst Date: Sun, 8 Jun 2025 22:31:32 -0700 Subject: [PATCH] README: split prep, build and test directions into own sections (#41) If we split this out, it'll be easier to point developers at specific parts for setting up their build environment, versus building and testing. Signed-off-by: Eric Ernst --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1d50c336..af95049d 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ The [Kata Containers](https://github.com/kata-containers/kata-containers) projec A kernel image named `vmlinux.container` can be found in the `/opt/kata/share/kata-containers/` directory of the release artifacts. -## Build the package +## Prepare to build package Install Swiftly, [Swift](https://www.swift.org), and [Static Linux SDK](https://www.swift.org/documentation/articles/static-linux-getting-started.html): @@ -99,10 +99,20 @@ swift sdk list swift sdk remove ``` -Build Containerization from sources and run basic and integration tests: +## Build the package + +Build Containerization from sources: ```bash -make all test integration +make all +``` + +## Test the package + +After building, run basic and integration tests: + +```bash +make test integration ``` A kernel is required to run integration tests.