Merge pull request #490 from detherminal/staging

docs: added hints to building.md
This commit is contained in:
julian-CStack 2023-04-19 09:44:05 -06:00 committed by GitHub
commit ecaac74e80
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,10 +4,10 @@ Here you will find instructions on how to install the necessary tools for buildi
### Prerequisites
- The OS'es supported for building is Ubuntu (20.04) and Fedora (37)
- The OS'es supported for building is Ubuntu (20.04) and Fedora (37 - Work In Progress)
- A machine with at least 100 GB of Storage
The following prerequisites can be installed with the setup script [`scripts/setup.sh`]["scripts/setup.sh"] or manually as described below:
The following prerequisites can be installed with the setup script [`scripts/setup.sh`](./../scripts/setup.sh) or manually as described below:
- Flutter 3.7.6 [(install manually or with git, do not install with snap)](https://docs.flutter.dev/get-started/install)
- Dart SDK Requirement (>=2.19.0, up until <3.0.0) (normally included with a flutter install)
@ -15,11 +15,12 @@ The following prerequisites can be installed with the setup script [`scripts/set
### Scripted setup
[`scripts/setup.sh`]["scripts/setup.sh"] is provided as a tool to set up installation for building: download the script and run it anywhere. This script should skip the entire [Manual setup](#manual-setup) section below and prepare you for [running](#running). It will set up the stack_wallet repository in `~/projects/stack_wallet` and build it there.
[`scripts/setup.sh`](./../scripts/setup.sh) is provided as a tool to set up installation for building: download the script and run it anywhere. This script should skip the entire [Manual setup](#manual-setup) section below and prepare you for [running](#running). It will set up the stack_wallet repository in `~/projects/stack_wallet` and build it there.
### Manual setup
> If you have installed with script, skip to [running](#running)
Please go to your Linux distribution's title below for instructions on how to manually setup:
- [Ubuntu (20.04)](#ubuntu-2004)
@ -37,7 +38,12 @@ The following *may* be needed for Android studio:
sudo apt-get install libc6:i386 libncurses5:i386 libstdc++6:i386 lib32z1 libbz2-1.0:i386
```
Install [Rust](https://www.rust-lang.org/tools/install)
Install [Rust](https://www.rust-lang.org/tools/install) with command:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Install the additional components for Rust:
```
cargo install cargo-ndk
rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
@ -75,7 +81,8 @@ sudo apt-get remove '^libboost.*-dev.*'
```
<!-- TODO: configure compiler to prefer built over system libraries. Should already use them? -->
Building plugins for Android
Building plugins for Android
> Warning: This will take a long time, please be patient
```
cd scripts/android/
./build_all.sh
@ -92,6 +99,10 @@ cd scripts/linux/
cd ../..
```
#### Fedora (37) (Work In Progress)
This is a work in progress, please use Ubuntu for now.
## Running
### Android
Plug in your android device or use the emulator available via Android Studio and then run the following commands:
@ -123,6 +134,4 @@ Use Tools > SDK Manager to install the SDK Tools > Android SDK (API 30), SDK Too
Then install the Flutter plugin and restart the IDE. In Android Studio's options for the Flutter language, enable auto format on save to match the project's code style. If you have problems with the Dart SDK, make sure to run `flutter` in a terminal to download it (use `source ~/.bashrc` to update your environment variables if you're still using the same terminal from which you ran `setup.sh`)
Make a Pixel 4 (API 30) x86_64 emulator with 2GB of storage space for emulation
#### Fedora (37) (Work In Progress)
Make a Pixel 4 (API 30) x86_64 emulator with 2GB of storage space for emulation