Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BUILDING.md #79

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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)
```

Expand Down
11 changes: 11 additions & 0 deletions docs/BUILD_DEBIAN-BOOKWORM_ARM64.md
Original file line number Diff line number Diff line change
@@ -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
```