From b0550235a191e2c2967b45e41cebf50d466e9e6f Mon Sep 17 00:00:00 2001 From: Marco Salazar <37784648+msalazarm@users.noreply.github.com> Date: Tue, 1 Mar 2022 09:25:15 +0800 Subject: [PATCH] Update README.md Added proper building instructions and updated readme --- README.md | 60 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index d219ccc..27d8305 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,53 @@ -# Paymint - A secure bitcoin wallet -Paymint is a Bitcoin thin client written in Dart with powerful features. +# Campfire - A secure Firo wallet +Campfire is a Firo thin client written in Dart with powerful features. -[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=com.paymintlabs.paymint) - -[Join the Telegram Group](https://www.t.me/paymintwallet) +[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=com.cypherstack.campfire) ## Feature List -✅ Basic fee selection controls - -✅ Coin Control -- UTXO renaming (labeling) -- Block/Unblock UTXOs -- Export Ouput data to CSV -- Restore Output labels and block status from CSV import - -✅ View transaction worth in fiat when sent/received to the wallet AND current worth -✅ Export transaction data to CSV +✅ View transaction worth in fiat when sent/received to the wallet AND current worth ✅ Preview transaction before sending -- View amount being sent + fee in BTC, sats, or fiat currency +- View amount being sent + fee in FIRO, sats, or fiat currency -✅ Custom Esplora-Electrs server support +✅ Custom Electrum server support ✅ 15 Currencies supported -✅ Native Segwit by default - ✅ And many more... ## Build and run ### Prerequisites -- Flutter SDK Requirement (>=2.2.0, up until <3.0.0) +- Flutter SDK Requirement (>=2.10.2, up until <3.0.0) - Android/iOS dev setup (Android Studio, xCode and subsequent dependencies) -- Navigate into project root and run the following: -Plug in your android device or use the emulator available via Android Studio and then run the following commands from project root: +After that download the project and init the submodules ``` -flutter pub get -flutter run --release +git clone https://github.com/cypherstack/Campfire.git +cd Campfire +git submodule update --init --recursive +``` + +Building plugins for Android ``` +cd crypto_plugins/flutter_liblelantus/scripts/android/ +// note if you are on a mac go one directory further to android_on_mac +./build_all.sh +// when finished go back to the root directory +cd ../../../.. +``` + +Building plugins for IOS -## Screenshots - +``` +cd crypto_plugins/flutter_liblelantus/scripts/ios/ +./build_all.sh +// when finished go back to the root directory +cd ../../../.. +``` - +Finally, plug in your android device or use the emulator available via Android Studio and then run the following commands: +``` +flutter pub get +flutter run +```