Skip to content

Commit

Permalink
Merge pull request #58 from aoki/main
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
utam0k authored Jun 3, 2021
2 parents 8723d42 + 727062c commit 25fbcc8
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
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 [email protected]: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 @@ -121,4 +125,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>

0 comments on commit 25fbcc8

Please sign in to comment.