Ecosystem/stack_wallet
1
0
Fork 0
mirror of https://github.com/cypherstack/stack_wallet.git synced 2024-12-23 03:49:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WIP incomplete building docs

Browse source
This commit is contained in:
julian 2024-06-07 09:11:25 -06:00
parent e76ee79c89
commit 6e3d96cdfa
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/building.md
View file

@ -13,12 +13,12 @@ Here you will find instructions on how to install the necessary tools for buildi
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. 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.
### Flutter ### Flutter
Install Flutter 3.19.6 by [following their guide](https://docs.flutter.dev/get-started/install/linux/desktop?tab=download#install-the-flutter-sdk). You can also clone https://github.com/flutter/flutter, check out the `3.19.6` tag, and add its `flutter/bin` folder to your PATH as in Install Flutter 3.22.1 by [following their guide](https://docs.flutter.dev/get-started/install/linux/desktop?tab=download#install-the-flutter-sdk). You can also clone https://github.com/flutter/flutter, check out the `3.22.1` tag, and add its `flutter/bin` folder to your PATH as in
```sh ```sh
FLUTTER_DIR="$HOME/development/flutter" FLUTTER_DIR="$HOME/development/flutter"
git clone https://github.com/flutter/flutter.git "$FLUTTER_DIR" git clone https://github.com/flutter/flutter.git "$FLUTTER_DIR"
cd "$FLUTTER_DIR" cd "$FLUTTER_DIR"
git checkout 3.16.9 git checkout 3.22.1
echo 'export PATH="$PATH:'"$FLUTTER_DIR"'/bin"' >> "$HOME/.profile" echo 'export PATH="$PATH:'"$FLUTTER_DIR"'/bin"' >> "$HOME/.profile"
source "$HOME/.profile" source "$HOME/.profile"
flutter precache flutter precache
@ -119,14 +119,14 @@ or manually by creating the files referenced in that script with the specified c
#### Building plugins for Android #### Building plugins for Android
> Warning: This will take a long time, please be patient > Warning: This will take a long time, please be patient
``` ```
cd scripts/android cd scripts
./build_all.sh ./build_app.sh -a stack_wallet -p android
``` ```
#### Building plugins for Linux #### Building plugins for Linux
``` ```
cd scripts/linux cd scripts
./build_all.sh ./build_app.sh -a stack_wallet -p linux
``` ```
##### Remove system packages (may be needed for building flutter_libmonero) ##### Remove system packages (may be needed for building flutter_libmonero)
@ -142,11 +142,11 @@ sudo apt-get remove '^libboost.*-dev.*'
``` ```
<!-- TODO: configure compiler to prefer built over system libraries. Should already use them? --> <!-- TODO: configure compiler to prefer built over system libraries. Should already use them? -->
#### Building plugins for Windows #### Building plugins and configure for Windows
``` ```
cd scripts/windows cd scripts
./deps.sh ./deps.sh
./build_all.sh ./build_app.sh -a stack_wallet -p windows
``` ```
### Running ### Running
@ -203,19 +203,19 @@ rustup target add aarch64-apple-ios aarch64-apple-darwin
Optionally download [Android Studio](https://developer.android.com/studio) as an IDE and activate its Dart and Flutter plugins. VS Code may work as an alternative, but this is not recommended. Optionally download [Android Studio](https://developer.android.com/studio) as an IDE and activate its Dart and Flutter plugins. VS Code may work as an alternative, but this is not recommended.
### Flutter ### Flutter
Install [Flutter](https://docs.flutter.dev/get-started/install) 3.16.8 on your Mac host by following [these instructions](https://docs.flutter.dev/get-started/install/macos). Run `flutter doctor` in a terminal to confirm its installation. Install [Flutter](https://docs.flutter.dev/get-started/install) 3.22.1 on your Mac host by following [these instructions](https://docs.flutter.dev/get-started/install/macos). Run `flutter doctor` in a terminal to confirm its installation.
### Build plugins ### Build plugins and configure
#### Building plugins for iOS #### Building plugins for iOS
``` ```
cd scripts/ios cd scripts
./build_all.sh ./build_app.sh -a stack_wallet -p ios
``` ```
#### Building plugins for macOS #### Building plugins for macOS
``` ```
cd scripts/macos cd scripts
./build_all.sh ./build_app.sh -a stack_wallet -p macos
``` ```
### Run prebuild script ### Run prebuild script
@ -278,13 +278,13 @@ Copy the resulting `dll`s to their respective positions on the Windows host:
Frostdart will be built by the Windows host later. Frostdart will be built by the Windows host later.
### Install Flutter on Windows host ### Install Flutter on Windows host
Install Flutter 3.19.6 on your Windows host (not in WSL2) by [following their guide](https://docs.flutter.dev/get-started/install/windows/desktop?tab=download#install-the-flutter-sdk) or by cloning https://github.com/flutter/flutter, checking out the `3.19.6` tag, and adding its `flutter/bin` folder to your PATH as in Install Flutter 3.22.1 on your Windows host (not in WSL2) by [following their guide](https://docs.flutter.dev/get-started/install/windows/desktop?tab=download#install-the-flutter-sdk) or by cloning https://github.com/flutter/flutter, checking out the `3.22.1` tag, and adding its `flutter/bin` folder to your PATH as in
```bat ```bat
@echo off @echo off
set "FLUTTER_DIR=%USERPROFILE%\development\flutter" set "FLUTTER_DIR=%USERPROFILE%\development\flutter"
git clone https://github.com/flutter/flutter.git "%FLUTTER_DIR%" git clone https://github.com/flutter/flutter.git "%FLUTTER_DIR%"
cd /d "%FLUTTER_DIR%" cd /d "%FLUTTER_DIR%"
git checkout 3.16.9 git checkout 3.22.1
setx PATH "%PATH%;%FLUTTER_DIR%\bin" setx PATH "%PATH%;%FLUTTER_DIR%\bin"
echo Flutter setup completed. Please restart your command prompt. echo Flutter setup completed. Please restart your command prompt.
``` ```