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

doc: Build instructions for macOS. #163

Merged
merged 1 commit into from
Dec 3, 2024
Merged
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
39 changes: 39 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Building Rune

## macOS

> This chapter provides instructions for building Rune on macOS for **development**. If you want to fork Rune and build your own version for production, you need to set up your own code signing, provisioning profiles, etc., which is not covered in this chapter.

### Prerequisites

- Xcode
- [Homebrew](https://brew.sh)

### Steps

1. Clone the repository:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: Missing repository URL or clone command

Please provide the git clone command with the repository URL to help users get started.

2. Install all development dependencies:
```sh
./scripts/macos_1_install.sh
```

> If you're an employee of *Inkwire Tech*, make sure you have an Apple Account in *Inkwire Tech*'s Developer Program logged in on your Xcode, and skip to Step #6. Ask @laosb if you can't make it work.

3. Open the project in Xcode:
```sh
open ./macos/Runner.xcworkspace
```
4. In Xcode, select the `Runner` project in the project navigator, then select the `Runner` target.
5. In the *Signing & Capabilities* tab:
1. Uncheck *Automatically manage signing*.
2. Select *None* for *Provisioning Profile*.
3. Select *None* for *Team*.
4. Select *Sign to Run Locally* for *Signing Certificate*.
6. Build / run the project:
```sh
./scripts/macos_2_build.sh
# or
./scripts/macos_2_run.sh
```

We use the signing configuration in our production GitHub Actions workflow, so please don't commit and push any changes to the signing configuration.
Loading