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

add some widgets to README.md #76

Merged
merged 1 commit into from
Jun 9, 2021
Merged

add some widgets to README.md #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# youki: A container runtime in Rust

[![Discord](https://img.shields.io/discord/849943000770412575.svg?logo=discord)](https://discord.gg/NtAbbGn)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/containers/youki)
![GitHub contributors](https://img.shields.io/github/contributors/containers/youki)

<p align="center">
<img src="docs/youki.png" width="230" height="230">
</p>
Expand Down Expand Up @@ -36,9 +40,11 @@ For other platforms, please use the devcontainer that we prepared.
- Docker(See [here](https://docs.docker.com/engine/install))

## Building

```sh
$ cargo install cargo-when # installs prerequisite for building youki
```

```sh
$ git clone [email protected]:containers/youki.git
$ cd youki
Expand All @@ -47,6 +53,7 @@ $ ./youki -h # you can get information about youki command
```

## Tutorial

Let's try to run a container that executes `sleep 5` using youki.
Maybe this tutorial is need permission as root.

Expand Down Expand Up @@ -98,6 +105,7 @@ $ ./integration_test.sh
```

# Community

We also have an active [Discord](https://discord.gg/h7R3HgWUct) if you'd like to come and chat with us.

# Design and implementation of youki
Expand Down