Docker
This section describes how to build KidneyOS using Docker.
Clone Repository
Clone the repository and cd
into the resulting directory. (Depending on how your instructor wants you to submit your work, they may have given you an alternate repository URL. If so, use that URL instead of the one below.)
git clone https://github.com/KidneyOS/KidneyOS
cd KidneyOS
Install Docker
If you already have Docker installed, you can skip this step. If you're on Linux, install the docker
package using your package manager. Otherwise, install Docker Desktop, which can be downloaded for MacOS from here or for Windows from here.
Run Container
Then execute the appropriate script. For Linux or MacOS, use the following:
scripts/run-container.bash
...or for Windows:
scripts/run-container.ps1
This will pull the container from the GitHub container registry and start it. You will need to run the container with the script above each time you want to build KidneyOS.
Install Host Tools
Since we can't run graphical tools inside the Docker container, we'll have to install the following two packages on the host:
qemu
bochs
(Optional, but recommended as it is useful for debugging. See the corresponding "Useful Tools" section for more information.)