Skip to content

Commit

Permalink
Change README instructions for acquiring SDK
Browse files Browse the repository at this point in the history
The artefacts produced from the GitHub Actions expire after
a certain amount of time and require you to be logged in. This
is easier for the meantime while we still need a dev version of
Microkit.
  • Loading branch information
Ivan-Velickovic committed Dec 21, 2023
1 parent f5bb2ea commit c6998b9
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,23 @@ For acquiring the SDK, you have two options.

##### Option 1 - Download pre-built SDK

Go to this page: https://github.com/Ivan-Velickovic/microkit/actions/runs/7108797946 and scroll to the bottom.
On Linux (x86-64):
```sh
wget https://trustworthy.systems/Downloads/microkit/microkit-sdk-dev-4f717f2-linux-x86-64.tar.gz
tar xf microkit-sdk-dev-4f717f2-linux-x86-64.tar.gz
```

Click on the artefact that matches the system you will be using the SDK on (e.g Linux x86-64 or macOS AArch64).
You will then have to unzip and untar it (unfortunately GitHub zips the archive no matter what).
On macOS (Apple Silicon/AArch64):
```sh
wget https://trustworthy.systems/Downloads/microkit/microkit-sdk-dev-4f717f2-macos-aarch64.tar.gz
tar xf microkit-sdk-dev-4f717f2-macos-aarch64.tar.gz
```

On macOS (Intel/x86-64):
```sh
wget https://trustworthy.systems/Downloads/microkit/microkit-sdk-dev-4f717f2-macos-x86-64.tar.gz
tar xf microkit-sdk-dev-4f717f2-macos-x86-64.tar.gz
```

##### Option 2 - Building the SDK

Expand All @@ -89,7 +102,7 @@ From here, you can follow the instructions
[here](https://github.com/Ivan-Velickovic/microkit/tree/dev) to build the SDK.

If you have built the SDK then the path to the SDK should look something like
this: `microkit/release/microkit-sdk-1.2.6`.
this: `microkit/release/microkit-sdk-<VERSION>`.

### Building and running

Expand Down

0 comments on commit c6998b9

Please sign in to comment.