Skip to content

Commit

Permalink
Update running instructions
Browse files Browse the repository at this point in the history
Signed-off-by: cristian-vijelie <cristianvijelie@gmail.com>
  • Loading branch information
cristian-vijelie committed Oct 6, 2023
1 parent c416298 commit 19ce1e9
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
## This is the Unikraft Documentation website

It's the https://unikraft.org website for the latest version of
It's the <https://unikraft.org> website for the latest version of
[Unikraft](https://github.com/unikraft/unikraft) and
[KraftKit](https://kraftkit.sh).

### Building and testing locally

```
```console
yarn install

yarn run dev
```

### Using Docker

```console
docker build -t ghcr.io/unikraft/docs:base --target base .

docker run -it --rm -v $(pwd):/docs -w /docs -p 3000:3000 --entrypoint sh ghcr.io/unikraft/docs:base

yarn run dev
```

0 comments on commit 19ce1e9

Please sign in to comment.