Skip to content

Commit fd2d7a3

Browse files
Merge pull request #1233 from cypherstack/docs
Update docs
2 parents 82db664 + 80b9ecf commit fd2d7a3

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

docs/building.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ Here you will find instructions on how to install the necessary tools for buildi
1313

1414
The following instructions are for building and running on a Linux host. Alternatively, see the [Mac](#mac-host) and/or [Windows](#windows-host) section. This entire section (except for the Android Studio section) needs to be completed in WSL if building on a Windows host.
1515

16+
### Flutter
17+
Install Flutter 3.38.5 by [following their guide](https://docs.flutter.dev/get-started/install/linux/desktop?tab=download#install-the-flutter-sdk). Run `flutter doctor` in a terminal to confirm its installation.
18+
1619
### Android Studio
1720
Install Android Studio. Follow instructions here [https://developer.android.com/studio/install#linux](https://developer.android.com/studio/install#linux) or install via snap:
1821
```
@@ -21,7 +24,7 @@ sudo apt install -y openjdk-11-jdk
2124
sudo snap install android-studio --classic
2225
```
2326

24-
Use `Tools > SDK Manager` to install:
27+
Use `Tools > SDK Manager` and navigate to `Languages & Frameworks > Android SDK > SDK tools` to install:
2528
- `SDK Tools > Android SDK command line tools`
2629
- `SDK Tools > CMake`
2730
and for Android builds,
@@ -149,6 +152,8 @@ cd scripts
149152
```
150153

151154
#### Building plugins and configure for Windows
155+
*This step is only necessary inside WSL2 for building on a Windows host.*
156+
152157
Install dependencies like MXE:
153158
```
154159
cd scripts/windows
@@ -204,11 +209,11 @@ brew install brotli cairo coreutils gdbm gettext glib gmp libevent libidn2 libng
204209
```
205210
<!-- TODO: determine which of the above list are not needed at all. -->
206211

207-
Download and install [Rust](https://www.rust-lang.org/tools/install). [Rustup](https://rustup.rs/) is recommended for Rust setup. Use `rustc` to confirm successful installation. Install toolchains 1.81.0 and 1.85.1 and `cbindgen` and `cargo-lipo` too. You will also have to add the platform target(s) `aarch64-apple-ios` and/or `aarch64-apple-darwin`. You can use the command(s):
212+
Download and install [Rust](https://www.rust-lang.org/tools/install). [Rustup](https://rustup.rs/) is recommended for Rust setup. Use `rustc` to confirm successful installation. Install toolchains 1.81.0, 1.85.1, and 1.86.0, as well as `cbindgen` and `cargo-lipo` too. You will also have to add the platform target(s) `aarch64-apple-ios` and/or `aarch64-apple-darwin`. You can use the command(s):
208213
```
209214
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
210215
source ~/.bashrc
211-
rustup install 1.85.1 1.81.0
216+
rustup install 1.86.0 1.85.1 1.81.0
212217
rustup default 1.85.1
213218
cargo install cargo-ndk
214219
cargo install cbindgen cargo-lipo
@@ -264,7 +269,7 @@ flutter run macos
264269
Visual Studio is required for Windows development with the Flutter SDK. Download it at https://visualstudio.microsoft.com/downloads/ and install the "Desktop development with C++", "Linux development with C++", and "Visual C++ build tools" workloads. You may also need the Windows 10, 11, and/or Universal SDK workloads depending on your Windows version.
265270

266271
### Build plugins in WSL2
267-
Set up Ubuntu 20.04 in WSL2. Follow the entire Linux host section in the WSL2 Ubuntu 20.04 host to get set up to build. The Android Studio section may be skipped in WSL (it's only needed on the Windows host).
272+
Set up Ubuntu 24.04 in WSL2. Follow the entire Linux host section in the WSL2 Ubuntu 24.04 host to get set up to build. The Android Studio section may be skipped in WSL (it's only needed on the Windows host).
268273

269274
Install the following libraries:
270275
```
@@ -284,14 +289,12 @@ If the DLLs were built on the WSL filesystem instead of on Windows, copy the res
284289
Frostdart will be built by the Windows host later.
285290

286291
### Install Flutter on Windows host
287-
Install Flutter 3.38.5 on your Windows host (not in WSL2) by [following their guide](https://docs.flutter.dev/install/manual).
288-
289-
Run `flutter doctor` in PowerShell to confirm its installation.
292+
Install Flutter 3.38.5 on your Windows host (not in WSL2) by [following their guide](https://docs.flutter.dev/install/manual). Run `flutter doctor` in PowerShell to confirm its installation.
290293

291294
### Rust
292295
Install [Rust](https://www.rust-lang.org/tools/install) on the Windows host (not in WSL2). Download the installer from [rustup.rs](https://rustup.rs), make sure it works on the commandline (you may need to open a new terminal), and install the following versions:
293296
```
294-
rustup install 1.85.1 1.81.0
297+
rustup install 1.86.0 1.85.1 1.81.0
295298
rustup default 1.85.1
296299
cargo install cargo-ndk
297300
```

0 commit comments

Comments
 (0)