Commit 5846eceb authored by Nick Elsmore's avatar Nick Elsmore

README: update to reflect recent changes

parent c7d7772f
# PyraOS Build System
The PyraOS build system utilizes `docker.io` to manage a clean and isolated build environment for building PyraOS images and packages.
The PyraOS build system utilizes `docker.io` to manage a clean and isolated build environment for building PyraOS images and packages.
## Setting up your host
......@@ -18,7 +18,8 @@ Note, you will probably need to add your user to the `docker` group.
sudo usermod -a -G docker $USER
```
Also ensure that you have an ssh key created named `id_rsa` in `~/.ssh`.
Also ensure that you have an ssh key created named `id_rsa` in `~/.ssh`.
At this point, you will need to reboot to ensure that your user is properly associated with the `docker` group.
### Setting up your build environment
......@@ -32,7 +33,7 @@ cd /path/to/build/location
Next, you'll need to create the directory on your host system where we'll be doing all the work. This directory will be linked into the docker environment when we start up the container.
```
mkdir -p pyra-build
mkdir -p /path/to/docker/directory/../build
```
Now we're ready to build the docker image. This will create and configure a base image of our build environment. If you're curious to see what's going on here or want to modify it, check out `Dockerfile`. Note that as long as you don't modify `Dockerfile` or `docker-entrypoint.sh` (pulling new commits from the remote counts as modifying), you only have to do this once.
......@@ -47,7 +48,7 @@ Now we're ready to build the docker image. This will create and configure a bas
Once you have the docker image built, you're ready to start using it to build a PyraOS image. Building an image consists of three steps: building U-Boot, building the rootfs from the Pyra repository (this uses the most recent stable kernel in the repo), and creating the virtual disk image.
First, sync your source repositories with the remote. This will take a fair amount of time.
First, sync your source repositories with the remote. This will take a fair amount of time. Note: before doing this, ensure that your git configuration is already set up. The sync will fail if it is not.
```
./docker_run.sh sync-manifest
......@@ -71,7 +72,7 @@ Finally, create the virtual disk image. Warning: This step makes use of your ho
./docker_run.sh build image
```
All binaries will be located within `pyra-build/out`. Note that the following command can be used to build everything at once, however it will build the kernel as well. The kernel built during this step is NOT the one used in the final image.
All binaries will be located within `build/out`. Note that the following command can be used to build everything at once, however it will build the kernel as well. The kernel built during this step is NOT the one used in the final image.
```
./docker_run.sh build-all
......@@ -115,4 +116,4 @@ One of the main goals of PyraOS/LetuxOS is to push changes back to mainline. Th
Linux coding style: https://www.kernel.org/doc/html/v4.17/process/coding-style.html
U-Boot coding style: https://www.denx.de/wiki/U-Boot/CodingStyle
\ No newline at end of file
U-Boot coding style: https://www.denx.de/wiki/U-Boot/CodingStyle
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment