Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(library): Update the README for base #99

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(library): Update the README for base #99

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6f57ea
feat(library): Updated the README for base
UjjwalMahar Mar 11, 2024
300f2b0
Update library/base/README.md
UjjwalMahar Aug 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions library/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Base Image

Base image is a Unikraft runtime built from [app-elfloader]() that loads and runs Linux native binaries using the [binary-compatibility mode](https://unikraft.org/docs/concepts/compatibility).
UjjwalMahar marked this conversation as resolved.
Show resolved Hide resolved

This directory contains the definition for the `unikraft.org/base:latest` image.

To run this image, [install Unikraft's companion command-line tool chain `kraft`](https://unikraft.org/docs/cli) and then you can run:

```
kraft run unikraft.org/base:latest
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a note that the base image is not supposed to be used by itself, and will be used by other applications.