Skip to content

Commit 2eab96a

Browse files
author
Marco
committed
update Readme
1 parent 53b1047 commit 2eab96a

File tree

1 file changed

+29
-12
lines changed

1 file changed

+29
-12
lines changed

README.md

Lines changed: 29 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
11
[![codecov](https://codecov.io/gh/cypherstack/stack_wallet/branch/main/graph/badge.svg?token=PM1N56UTEW)](https://codecov.io/gh/cypherstack/stack_wallet)
22

33
# Stack Wallet
4-
put details here
4+
Stack Wallet is a fully open source cryptocurrency wallet. With an easy to use user interface and quick and speedy transactions, this wallet is ideal for anyone no matter how much they know about the cryptocurrency space. The app is actively maintained to provide new user friendly features.
55

66
[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=com.cypherstack.stackwallet)
77

88
## Feature List
9-
put features here
9+
10+
Highlights include:
11+
- 5 Different cryptocurrencies
12+
- All private keys and seeds stay on device and are never shared.
13+
- Easy backup and restore feature to save all the information that's important to you.
14+
- Trading cryptocurrencies through our partners.
15+
- Custom address book
16+
- Favorite wallets with fast syncing
17+
- Custom Nodes.
18+
- Open source software.
1019

1120
## Build and run
1221
### Prerequisites
13-
- Flutter 3.0.5
22+
- The only OS supported for building is Ubuntu 20.04
23+
- A machine with at least 100 GB of Storage
24+
- Flutter 3.0.5 [(install manually or with git, do not install with snap)](https://docs.flutter.dev/get-started/install)
1425
- Dart SDK Requirement (>=2.17.0, up until <3.0.0)
15-
- Android/iOS dev setup (Android Studio, xCode and subsequent dependencies)
26+
- Android setup ([Android Studio](https://developer.android.com/studio) and subsequent dependencies)
1627

1728
After that download the project and init the submodules
1829
```
@@ -21,18 +32,22 @@ cd stack_wallet
2132
git submodule update --init --recursive
2233
```
2334

24-
Building plugins for Android
25-
```
26-
cd scripts/android/
27-
./build_all.sh
28-
// when finished go back to the root directory
29-
cd ../..
35+
You will need to install all dependencies listed in each of the plugins in the crypto_plugins folder. (eg. [Monero](https://github.com/cypherstack/flutter_libmonero), [Epic Cash](https://github.com/cypherstack/flutter_libepiccash) ) as of Sep 8th 2022 that is:
36+
37+
Install [Rust](https://www.rust-lang.org/tools/install)
3038
```
39+
cargo install cargo-ndk
40+
rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-android x86_64-linux-android
3141
32-
Building plugins for IOS
42+
sudo apt install libc6-dev-i386
43+
sudo apt install build-essential cmake git libgit2-dev clang libncurses5-dev libncursesw5-dev zlib1g-dev pkg-config llvm
44+
sudo apt install build-essential debhelper cmake libclang-dev libncurses5-dev clang libncursesw5-dev cargo rustc opencl-headers libssl-dev pkg-config ocl-icd-opencl-dev
45+
sudo apt install unzip automake build-essential file pkg-config git python libtool libtinfo5 cmake openjdk-8-jre-headless
46+
```
3347

48+
Building plugins for Android
3449
```
35-
cd scripts/ios/
50+
cd scripts/android/
3651
./build_all.sh
3752
// when finished go back to the root directory
3853
cd ../..
@@ -52,3 +67,5 @@ Finally, plug in your android device or use the emulator available via Android S
5267
flutter pub get
5368
flutter run
5469
```
70+
71+
Note on Emulators: Only x86_64 emulators are supported, x86 emulators will not work

0 commit comments

Comments
 (0)