Skip to content

README: split prep, build and test directions into own sections #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
egernst merged 1 commit into from
Jun 9, 2025
Merged

README: split prep, build and test directions into own sections #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down Expand Up @@ -99,10 +99,20 @@ swift sdk list
swift sdk remove <SDK-ID>
```

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.
Expand Down