diff --git a/README.md b/README.md index 6566bac..5a8545c 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,24 @@ If you decide to use HTTPS remotes, you might want to run `git config --global c If you need training to use Git, visit [Git Course in Plussa][git-plussa]. +## Docker instructions + +1. Install yocto as a submodule as instructed on the first assignment +2. Install docker on your machine. [Instructions][docker-install-instructions] +3. Download yocto cache files and extract them to cache/ +4. Change directory to scripts/ +5. Build the image by executing ./build_docker_image.sh +6. To run the container execute ./run_docker_container.sh + +The sstate_cache files are mounted in the container to /opt. Similar to the virtual machine provided. This allows parallel development with both environments. +The whole project is mounted to /home/yocto/yocto. +**Note**: All paths need to be relative. Use ${TOPDIR} to refer to the project root in yocto configs. [moodle.COMP.CE.460]: https://moodle.tuni.fi/course/view.php?id=50067 [git-plussa]: https://plus.tuni.fi/tie-git/ [course_upstream project]: https://course-gitlab.tuni.fi/comp-ce-460-embedded-linux-drivers_2025-2026/course_upstream [semipermanent-ssh-keys]: semipermanent-ssh-keys.md -[update_from_course_upstream]: https://course-gitlab.tuni.fi/comp-ce-460-embedded-linux-drivers_2025-2026/course_upstream/raw/main/scripts/update_from_course_upstream.sh \ No newline at end of file +[update_from_course_upstream]: https://course-gitlab.tuni.fi/comp-ce-460-embedded-linux-drivers_2025-2026/course_upstream/raw/main/scripts/update_from_course_upstream.sh +[docker-install-instructions]: https://docs.docker.com/engine/install/ + + diff --git a/scripts/run_docker_image.sh b/scripts/run_docker_container.sh similarity index 100% rename from scripts/run_docker_image.sh rename to scripts/run_docker_container.sh