Skip to content

Commit c153bbf

Browse files
committed
README.md: document build and installation steps of macOS generic variant
Signed-off-by: Jan Noha <nohajc@gmail.com>
1 parent 44fe919 commit c153bbf

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,29 @@ sudo make EFI=1 install
202202
203203
```
204204

205+
### macOS (generic variant)
206+
207+
#### Requirements
208+
209+
* A working [Rust](https://www.rust-lang.org/) toolchain
210+
* A host running macOS 14 or newer
211+
* Homebrew packages `lld` and `xz`
212+
213+
#### Compiling
214+
215+
```
216+
make [FEATURE_OPTIONS]
217+
```
218+
219+
The [init](init/init.c) binary is cross-compiled using clang and lld.
220+
A suitable sysroot is automatically generated by the Makefile from Debian repository.
221+
222+
#### Installing
223+
224+
```
225+
sudo make [FEATURE_OPTIONS] install
226+
```
227+
205228
## Using the library
206229

207230
Despite being written in Rust, this library provides a simple C API defined in [include/libkrun.h](include/libkrun.h)

0 commit comments

Comments
 (0)