diff --git a/docs/BUILDING.md b/docs/BUILDING.md index 67898398..87108142 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -177,6 +177,11 @@ git submodule update --init # Add `-DCMAKE_BUILD_TYPE:STRING=Release` if you're packaging cmake -H. -Bbuild-cmake -GNinja +# Copy ROM to working dir with the expected name +# Update $ROM_PATH to point to your ROM) +ROM_PATH=~/rom.z64 +cp $ROM_PATH baserom.us.rev1.z64 + # Generate sf64.otr cmake --build build-cmake --target ExtractAssets @@ -185,7 +190,7 @@ cmake --build build-cmake --target ExtractAssets cmake --build build-cmake # Now you can run the executable file: -./build-cmake/mm/starship-macos +./build-cmake/Starship # To develop the project open the repository in VSCode (or your preferred editor) ``` diff --git a/docs/BUILD_DEBIAN-BOOKWORM_ARM64.md b/docs/BUILD_DEBIAN-BOOKWORM_ARM64.md new file mode 100644 index 00000000..50d4116e --- /dev/null +++ b/docs/BUILD_DEBIAN-BOOKWORM_ARM64.md @@ -0,0 +1,11 @@ +# Building Starship +These build instructions are based on the upstream repository via their [GitHub Actions Workflow](https://github.com/HarbourMasters/Starship/blob/main/.github/workflows/linux.yml) and [build instructions](https://github.com/HarbourMasters/Starship/blob/main/docs/BUILDING.md). + +## Build Starship +``` +git clone --recursive https://github.com/HarbourMasters/starship.git && cd starship +git checkout tags/vx.x.x +cmake -H. -Bbuild-cmake -GNinja -DUSE_OPENGLES=1 -DBUILD_CROWD_CONTROL=0 -DCMAKE_BUILD_TYPE=Release +cmake --build build-cmake --config Release --target GeneratePortOTR +cmake --build build-cmake +```