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

Update README.md #58

Merged
merged 2 commits into from
Jun 3, 2021
Merged

Update README.md #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2494c4
Update README.md
aoki Jun 2, 2021
727062c
Update README: Split code section in tutorial
aoki Jun 3, 2021
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
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For other platforms, please use the devcontainer that we prepared.
$ git clone git@github.com:utam0k/youki.git
$ cd youki
$ ./build.sh
$ ./youki -h // you can get information about youki command
$ ./youki -h # you can get information about youki command
```

## Tutorial
Expand All @@ -54,14 +54,18 @@ $ mkdir tutorial
$ cd tutorial
$ mkdir rootfs
$ docker export $(docker create busybox) | tar -C rootfs -xvf -
// Prepare a configuration file for the container that will run `sleep 5`.
```

Prepare a configuration file for the container that will run `sleep 5`.

```sh
$ curl https://gist.githubusercontent.com/utam0k/8ab419996633066eaf53ac9c66d962e7/raw/e81548f591f26ec03d85ce38b0443144573b4cf6/config.json -o config.json
$ cd ../
$ ./youki create -b tutorial tutorial_container
$ ./youki state tutorial_container // You can see the state the container is in as it is being generate.
$ ./youki state tutorial_container # You can see the state the container is in as it is being generate.
$ ./youki start tutorial_container
$ ./youki state tutorial_container // Run it within 5 seconds to see the running container.
$ ./youki delete tutorial_container // Run it after the container is finished running.
$ ./youki state tutorial_container # Run it within 5 seconds to see the running container.
$ ./youki delete tutorial_container # Run it after the container is finished running.
```

Change the command to be executed in config.json and try something other than `sleep 5`.
Expand Down Expand Up @@ -118,4 +122,4 @@ Thanks to all the people who already contributed!

<a href="https://github.com/utam0k/youki/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=utam0k/youki" />
</a>
</a>