Initial commit

README.md

@@ -0,0 +1,58 @@
+# Yocto template
+
+Template for a yocto workspace to use with docker.
+
+## Requirements
+
+### Docker
+
+This template requires docker to work.
+See the [official manual](https://docs.docker.com/engine/install/) to set it up.
+
+### 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.
+
+## Workspace layout
+
+```bash
+yocto (origin)
+├── build
+│   └── conf
+├── .cache
+│   ├── docker
+│   └── yocto
+├── docker-compose.yaml
+├── .git
+├── .gitignore
+├── .gitmodules
+├── layers
+├── poky
+├── README.md
+└── scripts
+    ├── docker-entrypoint.sh
+    ├── setup-env.sh
+    ├── setup-paths.sh
+    └── start-docker.sh
+```
+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
+```