From 8ff236f60f8682b91d0e8c44db4b7e5488f05295 Mon Sep 17 00:00:00 2001 From: Anghelo Carvajal Date: Thu, 31 Jul 2025 10:48:58 -0400 Subject: [PATCH] Update docker docs. Some references were broken in the markdown files, and there's no longer a need to run the git `safe.directory` command since the docker file was doing it already --- README.md | 9 +++++---- docs/BUILDING_DOCKER.md | 10 ++-------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b4831aca25..9d4fc94e4c 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,6 @@ Preparation is covered in [Building Docker](docs/BUILDING_DOCKER.md). The build process has the following package requirements: -* make * git * build-essential * binutils-mips-linux-gnu @@ -77,7 +76,7 @@ Under Debian / Ubuntu (which we recommend using), you can install them with the ```bash sudo apt update -sudo apt install make git build-essential binutils-mips-linux-gnu curl python3 python3-pip python3-venv libpng-dev libxml2-dev +sudo apt install git build-essential binutils-mips-linux-gnu curl python3 python3-pip python3-venv libpng-dev libxml2-dev ``` #### 2. Clone the repository @@ -102,12 +101,14 @@ Rename the file to `baserom.z64`, `baserom.n64` or `baserom.v64`, depending on t #### 4. Make and Build the ROM -To start the extraction/build process, run the following command: +For a first time build, run the following command, where `N` is the number of cores your processor has (see the note at the bottom for more information): ```bash -make init +make init -j N ``` +After the very first build you'll want to run `make -j N` instead, since you likely won't need all the setup the `init` command provides. + The extraction/build process: 1. Prepares build environment: - Creates a Python virtual environment diff --git a/docs/BUILDING_DOCKER.md b/docs/BUILDING_DOCKER.md index 98eb9f1567..d279ad8dab 100644 --- a/docs/BUILDING_DOCKER.md +++ b/docs/BUILDING_DOCKER.md @@ -6,7 +6,7 @@ You will need [Docker](https://docs.docker.com/get-docker/) Follow the instructi ## 1. Clone the Repository -You will need to prepare a local version of the project with a copied base ROM (see steps [2](../README.md#2-clone-the-repository) and [4](../README.md#4-prepare-a-base-rom) of the Linux instructions). +You will need to prepare a local version of the project with a copied base ROM (see steps [2. Clone the repository](../README.md#2-clone-the-repository) and [3. Prepare a base ROM](../README.md#3-prepare-a-base-rom) of the Linux instructions). ## 2. Create the Docker image @@ -38,10 +38,4 @@ docker run -it --rm --mount type=bind,source="$(pwd)",destination=/mm mm "/usr/b ## 4. Setup and Build the ROM -Once inside the container, you will need to set the repository as a trusted repository with the following command: - -```bash -git config --global --add safe.directory /mm -``` - -After that continue with step [5. Make and Build the ROM](../README.md#5-make-and-build-the-rom) of the Linux instructions to setup and build the ROM, or run any other command you need. +After that continue with step [4. Make and Build the ROM](../README.md#4-make-and-build-the-rom) of the Linux instructions to setup and build the ROM, or run any other command you need.