diff --git a/README.md b/README.md index 7144713..b57b3fa 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ Template for a yocto workspace to use with docker. ## Requirements -### docker +### Docker This template requires docker to work. See the [official manual](https://docs.docker.com/engine/install/) to set it up. -### custom yocto docker image +### Yocto docker image The custom image is available on hub.anxietyprime.de/yocto:latest, but requires login. It can be build locally following the instructions in https://git.anxietyprime.de/timoschneider/docker-yocto. @@ -36,4 +36,23 @@ yocto (origin) ├── setup-paths.sh └── start-docker.sh ``` -The cache and download folders are auto generated. \ No newline at end of file +The cache and download folders are auto generated. + +## Usage + +### First use +To setup everything, the first time the container has to be started via the start-docker.sh script. +It will generate all folders and assert they are not owned by root. + +### Manage container +After the first start, the container can be managed by the default docker compose commands. + +### Enter container +The container can be entered by executing +```bash +docker attach yocto +``` +or +```bash +docker exec -it yocto zsh +``` \ No newline at end of file