Skip to content

Commit 8d09493

Browse files
authored
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 <eric_ernst@apple.com>
1 parent e285dc0 commit 8d09493

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The [Kata Containers](https://github.com/kata-containers/kata-containers) projec
7171

7272
A kernel image named `vmlinux.container` can be found in the `/opt/kata/share/kata-containers/` directory of the release artifacts.
7373

74-
## Build the package
74+
## Prepare to build package
7575

7676
Install Swiftly, [Swift](https://www.swift.org), and [Static Linux SDK](https://www.swift.org/documentation/articles/static-linux-getting-started.html):
7777

@@ -99,10 +99,20 @@ swift sdk list
9999
swift sdk remove <SDK-ID>
100100
```
101101

102-
Build Containerization from sources and run basic and integration tests:
102+
## Build the package
103+
104+
Build Containerization from sources:
103105

104106
```bash
105-
make all test integration
107+
make all
108+
```
109+
110+
## Test the package
111+
112+
After building, run basic and integration tests:
113+
114+
```bash
115+
make test integration
106116
```
107117

108118
A kernel is required to run integration tests.

0 commit comments

Comments
 (0)