Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Velickovic <[email protected]>
  • Loading branch information
Ivan-Velickovic committed Sep 8, 2024
1 parent b30a75a commit ce62161
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ intended to simply boot a Linux guest that has serial input and output.
* Microkit SDK (version 1.4.1)

For the Microkit SDK, you can download it from [here](https://github.com/seL4/microkit/releases/tag/1.4.1).

For all other dependencies, see the below instructions depending on your machine.

#### Ubuntu/Debian (apt):
Expand All @@ -46,28 +47,24 @@ sudo apt update && sudo apt install -y make clang lld llvm qemu-system-arm devic

If you do not have Homebrew installed, you can install it [here](https://brew.sh/).

It should be noted that while the examples in libvmm can be built
on macOS, if you need to do anything such as compile a custom Linux kernel image
or a guest root file system for developing your own system, you will probably have
less friction on a Linux machine.

```sh
# Note that you should make sure that the LLVM tools are in your path after running
# the install command. Homebrew does not do it automatically but does print out a
# message on how to do it.
brew install make qemu dtc llvm
```

It should be noted that while the examples in libvmm can be built
on macOS, if you need to do anything such as compile a custom Linux kernel image
or a guest root file system for developing your own system, you will probably have
less friction on a Linux machine.

#### Nix
```sh
# In the root of the repository
nix-shell
```

#### Acquiring the SDK

Finally, you will need version 1.4.1 of the Microkit SDK.

### Building and running

Finally, we can simulate a basic system with a single Linux guest with the
Expand Down

0 comments on commit ce62161

Please sign in to comment.