From 4944652d37806566aa695ba21b6a7b6e82b132ec Mon Sep 17 00:00:00 2001 From: Thomas Gazagnaire Date: Mon, 3 Apr 2017 11:16:42 +0200 Subject: [PATCH] miragesdk: improve dev README Signed-off-by: Thomas Gazagnaire --- projects/miragesdk/src/README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/projects/miragesdk/src/README.md b/projects/miragesdk/src/README.md index 9640b090c..a6d4aa6b9 100644 --- a/projects/miragesdk/src/README.md +++ b/projects/miragesdk/src/README.md @@ -1,7 +1,23 @@ -## DHCP client using MirageOS +### SDK -To debug/build, the `enter-dev` target will create a dev container where -`make dev` will build and run the current state of the prototype: +To build and test the SDK, run: + +``` +$ make test +``` + +This will work on any OS. + +### DHCP client using MirageOS + +To build the MirageOS DHCP client, run: + +``` +$ make dev +``` + +As this is using some BPF runes, this will work only on Linux. To debug/build +on OSX, you can create a container and build from there: ``` make enter-dev @@ -11,4 +27,4 @@ make dev ### Documentation -See the [general architecture document](../../doc/unikernel.md). \ No newline at end of file +See the [general architecture document](../../doc/unikernel.md).