Skip to content

Commit c2d3ee4

Browse files
committed
docs: Move the compiling document to a proper place
1 parent 63f6016 commit c2d3ee4

File tree

1 file changed

+38
-7
lines changed

1 file changed

+38
-7
lines changed

documents/compiling.md

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,44 @@ flutter run
6565

6666
For detailed integration instructions, refer to Rinf's [documentation](https://rinf.cunarist.com).
6767
68-
## Tips for Compiling on macOS
68+
## macOS
6969
70-
Rune currently does not support macOS, but here are some tips for attempting compilation:
70+
> 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.
7171
72-
- Ensure you have the Flutter SDK and Rust toolchain installed.
73-
- For [CocoaPods](https://cocoapods.org/), avoid using the default macOS Ruby version. Use Homebrew instead:
72+
### Prerequisites
7473
75-
```bash
76-
brew install cocoapods
77-
```
74+
- Xcode
75+
- [Homebrew](https://brew.sh)
76+
77+
### Steps
78+
79+
1. Clone the repository:
80+
```bash
81+
git clone https://github.com/losses/rune.git
82+
cd rune
83+
```
84+
2. Install all development dependencies:
85+
```sh
86+
./scripts/macos_1_install.sh
87+
```
88+
89+
> 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.
90+
91+
3. Open the project in Xcode:
92+
```sh
93+
open ./macos/Runner.xcworkspace
94+
```
95+
4. In Xcode, select the `Runner` project in the project navigator, then select the `Runner` target.
96+
5. In the *Signing & Capabilities* tab:
97+
1. Uncheck *Automatically manage signing*.
98+
2. Select *None* for *Provisioning Profile*.
99+
3. Select *None* for *Team*.
100+
4. Select *Sign to Run Locally* for *Signing Certificate*.
101+
6. Build / run the project:
102+
```sh
103+
./scripts/macos_2_build.sh
104+
# or
105+
./scripts/macos_2_run.sh
106+
```
107+
108+
We use the signing configuration in our production GitHub Actions workflow, so please don't commit and push any changes to the signing configuration.

0 commit comments

Comments
 (0)