summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorptweezy <ptweezy@runforyour.money>2024-12-15 19:12:09 -0500
committerGitHub <noreply@github.com>2024-12-15 19:12:09 -0500
commit15ed6585477ab909f18e038639b6488536f67eb6 (patch)
tree0d2b4d122a4af7b2cb19f0e69c1a72b0a52949fe /docs
parent81f89b52c9c819983c69dfbaf2d96e5abf0e6264 (diff)
Docker Build Change Proposal (#2373)
* removing due to deprecation * addressing docker build console issues, updating to latest LTS ubuntu, addressing Ubuntu + Python .venv requirements, standardizing environment * Update Dockerfile * proposed docker build changes * improving parallel build * removing * keep image open after build * updating based on feedback * update * fixed typo * revert --------- Co-authored-by: BuildTools <unconfigured@null.spigotmc.org> Co-authored-by: Parker <parker@runforyour.money>
Diffstat (limited to 'docs')
-rw-r--r--docs/BUILDING_DOCKER.md18
1 files changed, 8 insertions, 10 deletions
diff --git a/docs/BUILDING_DOCKER.md b/docs/BUILDING_DOCKER.md
index afc35b48b..98aed29c9 100644
--- a/docs/BUILDING_DOCKER.md
+++ b/docs/BUILDING_DOCKER.md
@@ -6,22 +6,20 @@ To use Docker, you'll need either Docker Desktop or Docker Toolbox installed and
You'll also need to prepare a local version of the project with a copied base ROM (see steps [2](../README.md#2-clone-the-repository) and [3](../README.md#3-prepare-a-base-rom) of the Linux instructions).
-## 2. Create the Docker image
+## 2. Create and start the Docker image build
-From inside your local project, run the following command:
+From the root of your local project, run the following command:
```bash
-docker build . -t oot
+docker-compose up --build
```
-## 3. Start the container
+This should immediately begin steps [4](../README.md#4-setup-the-rom-and-build-process) and [5](../README.md#5-build-the-rom) within the Docker container.
-To start the container, you can mount your local filesystem into the Docker container and run an interactive bash session.
+## 3. Shell into the 'oot' container
+
+To exec into the oot Docker image at any time, run the following command either during or after the build:
```bash
-docker run -it --rm --mount type=bind,source="$(pwd)",destination=/oot oot /bin/bash
+docker-compose exec oot bash
```
-
-## 4. Setup and Build the ROM
-
-Once inside the container, you can follow steps [4](../README.md#4-setup-the-rom-and-build-process) and [5](../README.md#5-build-the-rom) of the Linux instructions to setup and build the ROM, or run any other command you need.