@samitouri / QOSAMI-cakewallet-1 / commits / 01d40c4dc

Guides update (#1542)

* Rename build-guide-win.md to howto-build-windows.md * Update howto-build-windows.md * Update howto-build-windows.md * Update howto-build-windows.md * Update howto-build-windows.md * Update howto-build-android.md * Update howto-build-android.md * Update howto-build-macos.md * Update howto-build-macos.md * Update howto-build-ios.md * Update howto-build-android.md * Update howto-build-windows.md

tuxsudo committed Jul 19, 2024 at 02:37 UTC 01d40c4dc38705ef9df336541b1ef416e79562f5

5 files changed +105 -86

build-guide-win.md deleted

-38

@@ -1,38 +0,0 @@

1 -# Building CakeWallet for Windows

2 -

3 -## Requirements and Setup

4 -

5 -The following are the system requirements to build CakeWallet for your Windows PC.

6 -

7 -```

8 -Windows 10 or later (64-bit), x86-64 based

9 -Flutter 3 or above

10 -```

11 -

12 -## Building CakeWallet on Windows

13 -

14 -These steps will help you configure and execute a build of CakeWallet from its source code.

15 -

16 -### 1. Installing Package Dependencies

17 -

18 -For build CakeWallet windows application from sources you will be needed to have:

19 -> [Install Flutter]Follow installation guide (https://docs.flutter.dev/get-started/install/windows) and install do not miss to dev tools (install https://docs.flutter.dev/get-started/install/windows/desktop#development-tools) which are required for windows desktop development (need to install Git for Windows and Visual Studio 2022). Then install `Desktop development with C++` packages via GUI Visual Studio 2022, or Visual Studio Build Tools 2022 including: `C++ Build Tools core features`, `C++ 2022 Redistributable Update`, `C++ core desktop features`, `MVC v143 - VS 2022 C++ x64/x86 build tools`, `C++ CMake tools for Windwos`, `Testing tools core features - Build Tools`, `C++ AddressSanitizer`.

20 -> [Install WSL] for building monero dependencies need to install Windows WSL (https://learn.microsoft.com/en-us/windows/wsl/install) and required packages for WSL (Ubuntu):

21 -`$ sudo apt update `

22 -`$ sudo apt build-essential cmake gcc-mingw-w64 g++-mingw-w64 autoconf libtool pkg-config`

23 -

24 -### 2. Pull CakeWallet source code

25 -

26 -You can downlaod CakeWallet source code from our [GitHub repository](github.com/cake-tech/cake_wallet) via git by following next command:

27 -`$ git clone https://github.com/cake-tech/cake_wallet.git --branch MrCyjaneK-cyjan-monerodart`

28 -OR you can download it as [Zip archive](https://github.com/cake-tech/cake_wallet/archive/refs/heads/MrCyjaneK-cyjan-monerodart.zip)

29 -

30 -### 3. Build Monero, Monero_c and their dependencies

31 -

32 -For use monero in the application need to build Monero wrapper - Monero_C which will be used by monero.dart package. For that need to run shell (bash - typically same named utility should be available after WSL is enabled in your system) with previously installed WSL, then change current directory to the application project directory with your used shell and then change current directory to `scripts/windows`: `$ cd scripts/windows`. Run build script: `$ ./build_all.sh`.

33 -

34 -### 4. Configure and build CakeWallet application

35 -

36 -To configure the application open directory where you have downloaded or unarchived CakeWallet sources and run `cakewallet.bat`.

37 -Or if you used WSL and have active shell session you can run `$ ./cakewallet.sh` script in `scripts/windows` which will run `cakewallet.bat` in WSL.

38 -After execution of `cakewallet.bat` you should to get `Cake Wallet.zip` in project root directory which will contains `CakeWallet.exe` file and another needed files for run the application. Now you can extract files from `Cake Wallet.zip` archive and run the application.

howto-build-android.md

+20 -20

@@ -1,23 +1,19 @@

1 -# Building CakeWallet for Android

1 +# Building Cake Wallet for Android

3 ## Requirements and Setup

5 -The following are the system requirements to build CakeWallet for your Android device.

5 +The following are the system requirements to build Cake Wallet for your Android device.

7 ```

8 Ubuntu >= 20.04

9 Android SDK 29 or higher (better to have the latest one 33)

10 Android NDK 17c

11 -Flutter 3.19.x or earlier

11 +Flutter 3.19.x

12 ```

14 -## Building CakeWallet on Android

15 -

16 -These steps will help you configure and execute a build of CakeWallet from its source code.

17 -

14 ### 1. Installing Package Dependencies

20 -CakeWallet cannot be built without the following packages installed on your build system.

16 +CakeWallet cannot be built without the following packages installed on your system.

18 - curl

@@ -51,13 +47,17 @@ You may easily install them on your build system with the following command:

48 ### 2. Installing Android Studio and Android toolchain

54 -You may download and install the latest version of Android Studio [here](https://developer.android.com/studio#downloads). After installing, start Android Studio, and go through the "Setup Wizard." This installs the latest Android SDK, Android SDK Command-line Tools, and Android SDK Build-Tools, which are required by CakeWallet. **Be sure you are installing SDK version 28 or later when stepping through the wizard**

50 +You may download and install the latest version of Android Studio [here](https://developer.android.com/studio#downloads). After installing, start Android Studio, and go through the "Setup Wizard." This installs the latest Android SDK, Android SDK Command-line Tools, and Android SDK Build-Tools, which are required by Cake Wallet. **Be sure you are installing SDK version 28 or later when stepping through the wizard**

52 ### 3. Installing Flutter

58 -Need to install flutter with version `3.19.x`. For this please check section [Install Flutter manually](https://docs.flutter.dev/get-started/install/linux#install-flutter-manually).

54 +Install Flutter with version `3.19.x`. For this please check section [Install Flutter manually](https://docs.flutter.dev/get-started/install/linux#install-flutter-manually).

55 +

56 +### 4. Installing rustup

57 +

58 +Install rustup from the [rustup.rs](https://rustup.rs/) website.

60 -### 4. Verify Installations

60 +### 5. Verify Installations

62 Verify that the Android toolchain, Flutter, and Android Studio have been correctly installed on your system with the following command:

@@ -71,15 +71,15 @@ Doctor summary (to see all details, run flutter doctor -v):

71 [✓] Android Studio (version 4.0 or higher)

72 ```

74 -### 5. Generate a secure keystore for Android

74 +### 6. Generate a secure keystore for Android

76 `$ keytool -genkey -v -keystore $HOME/key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias key`

78 You will be prompted to create two passwords. First you will be prompted for the "store password", followed by a "key password" towards the end of the creation process. **TAKE NOTE OF THESE PASSWORDS!** You will need them in later steps.

80 -### 6. Acquiring the CakeWallet Source Code

80 +### 7. Acquiring the Cake Wallet Source Code

82 -Create the directory that will be use to store the CakeWallet source...

82 +Create the directory that will be use to store the Cake Wallet source...

84 ```

85 $ sudo mkdir -p /opt/android

@@ -95,11 +95,11 @@ Proceed into the source code before proceeding with the next steps:

96 `$ cd cake_wallet/scripts/android/`

98 -### 7. Installing Android NDK

98 +### 8. Installing Android NDK

100 `$ ./install_ndk.sh`

101

102 -### 8. Execute Build & Setup Commands for CakeWallet

102 +### 9. Execute Build & Setup Commands for Cak eWallet

103

104 We need to generate project settings like app name, app icon, package name, etc. For this need to setup environment variables and configure project files.

105

@@ -116,7 +116,7 @@ Build the Monero libraries and their dependencies:

116

117 `$ ./build_all.sh`

118

119 -It is now time to change back to the base directory of the CakeWallet source code:

119 +It is now time to change back to the base directory of the Cake Wallet source code:

120

121 `$ cd ../../`

122

@@ -124,7 +124,7 @@ Install Flutter package dependencies with this command:

124

125 `$ flutter pub get`

126

127 -Your CakeWallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

127 +Your Cake Wallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

128

129 `$ flutter packages pub run tool/generate_new_secrets.dart`

130

@@ -142,8 +142,8 @@ Finally build mobx models for the app:

142

143 `$ ./model_generator.sh`

144

145 -### 9. Build!

145 +### 10. Build!

146

147 `$ flutter build apk --release`

148

howto-build-ios.md

+14 -14

@@ -1,8 +1,8 @@

1 -# Building CakeWallet for iOS

1 +# Building Cake Wallet for iOS

3 ## Requirements and Setup

5 -The following are the system requirements to build CakeWallet for your iOS device.

5 +The following are the system requirements to build Cake Wallet for your iOS device.

7 ```

8 macOS >= 14.0

@@ -10,13 +10,9 @@ Xcode 15.3

10 Flutter 3.19.x

11 ```

13 -## Building CakeWallet on iOS

14 -

15 -These steps will help you configure and execute a build of CakeWallet from its source code.

16 -

13 ### 1. Installing Package Dependencies

19 -CakeWallet cannot be built without the following packages installed on your build system.

15 +Cake Wallet cannot be built without the following packages installed on your build system.

17 For installing dependency tools you can use brew [Install brew](https://brew.sh).

@@ -32,7 +28,11 @@ You may download and install the latest version of [Xcode](https://developer.app

29 Need to install flutter with version `3.19.x`. For this please check section [Install Flutter](https://docs.flutter.dev/get-started/install/macos/mobile-ios?tab=download).

35 -### 4. Verify Installations

31 +### 4. Installing rustup

32 +

33 +Install rustup from the [rustup.rs](https://rustup.rs/) website.

34 +

35 +### 5. Verify Installations

37 Verify that the Flutter and Xcode have been correctly installed on your system with the following command:

@@ -45,7 +45,7 @@ Doctor summary (to see all details, run flutter doctor -v):

45 [✓] Xcode - develop for iOS and macOS (Xcode 15.3)

46 ```

48 -### 5. Acquiring the CakeWallet source code

48 +### 6. Acquiring the CakeWallet source code

50 Download the source code.

@@ -55,7 +55,7 @@ Proceed into the source code before proceeding with the next steps:

56 `$ cd cake_wallet/scripts/ios/`

58 -### 6. Execute Build & Setup Commands for CakeWallet

58 +### 7. Execute Build & Setup Commands for Cake Wallet

60 We need to generate project settings like app name, app icon, package name, etc. For this need to setup environment variables and configure project files.

@@ -72,7 +72,7 @@ Build the Monero libraries and their dependencies:

73 `$ ./build_monero_all.sh`

75 -It is now time to change back to the base directory of the CakeWallet source code:

75 +It is now time to change back to the base directory of the Cake Wallet source code:

77 `$ cd ../../`

@@ -80,7 +80,7 @@ Install Flutter package dependencies with this command:

81 `$ flutter pub get`

83 -Your CakeWallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

83 +Your Cake Wallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

85 `$ flutter packages pub run tool/generate_new_secrets.dart`

@@ -88,7 +88,7 @@ Then we need to generate localization files and mobx models.

89 `$ ./configure_cake_wallet.sh ios`

91 -### 7. Build!

91 +### 8. Build!

93 `$ flutter build ios --release`

@@ -98,4 +98,4 @@ Or if you want to run to connected device:

99 `$ flutter run --release`

100

howto-build-macos.md

+14 -14

@@ -1,8 +1,8 @@

1 -# Building CakeWallet for macOS

1 +# Building Cake Wallet for macOS

3 ## Requirements and Setup

5 -The following are the system requirements to build CakeWallet for your macOS device.

5 +The following are the system requirements to build Cake Wallet for your macOS device.

7 ```

8 macOS >= 14.0

@@ -10,13 +10,9 @@ Xcode 15.3

10 Flutter 3.19.x

11 ```

13 -## Building CakeWallet on macOS

14 -

15 -These steps will help you configure and execute a build of CakeWallet from its source code.

16 -

13 ### 1. Installing Package Dependencies

19 -CakeWallet cannot be built without the following packages installed on your build system.

15 +Cake Wallet cannot be built without the following packages installed on your build system.

17 For installing dependency tools you can use brew [Install brew](https://brew.sh).

@@ -34,7 +30,11 @@ You may download and install the latest version of [Xcode](https://developer.app

31 Need to install flutter with version `3.19.x`. For this please check section [Install Flutter](https://docs.flutter.dev/get-started/install/macos/desktop?tab=download).

37 -### 4. Verify Installations

33 +### 4. Installing rustup

34 +

35 +Install rustup from the [rustup.rs](https://rustup.rs/) website.

36 +

37 +### 5. Verify Installations

39 Verify that Flutter and Xcode have been correctly installed on your system with the following command:

@@ -47,7 +47,7 @@ Doctor summary (to see all details, run flutter doctor -v):

47 [✓] Xcode - develop for iOS and macOS (Xcode 15.3)

48 ```

50 -### 5. Acquiring the CakeWallet source code

50 +### 6. Acquiring the Cake Wallet source code

52 Download the source code.

@@ -57,7 +57,7 @@ Proceed into the source code before proceeding with the next steps:

58 `$ cd cake_wallet/scripts/macos/`

60 -### 6. Execute Build & Setup Commands for CakeWallet

60 +### 7. Execute Build & Setup Commands for Cake Wallet

62 We need to generate project settings like app name, app icon, package name, etc. For this need to setup environment variables and configure project files.

@@ -83,7 +83,7 @@ If you be needed to build universal monero lib, then it will require additional

84 If you will be needed to build monero wallet lib only for x86_64 on arm64 mac, then you need use steps above, but run build script with rosetta without arguments: `$ arch -x86_64 ./build_monero_all.sh`.

86 -It is now time to change back to the base directory of the CakeWallet source code:

86 +It is now time to change back to the base directory of the Cake Wallet source code:

88 `$ cd ../../`

@@ -91,7 +91,7 @@ Install Flutter package dependencies with this command:

92 `$ flutter pub get`

94 -Your CakeWallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

94 +Your Cake Wallet binary will be built with cryptographic salts, which are used for secure encryption of your data. You may generate these secret salts with the following command:

96 `$ flutter packages pub run tool/generate_new_secrets.dart`

@@ -99,7 +99,7 @@ Then we need to generate localization files and mobx models.

100 `$ ./configure_cake_wallet.sh macos`

101

102 -### 7. Build!

102 +### 8. Build!

103

104 `$ flutter build macos --release`

105

@@ -109,4 +109,4 @@ Or if you want to run to connected device:

109

110 `$ flutter run --release`

111

howto-build-windows.md new

+57

@@ -0,0 +1,57 @@

1 +# Building Cake Wallet for Windows

2 +

3 +## Requirements and Setup

4 +

5 +The following are the system requirements to build CakeWallet for your Windows PC.

6 +

7 +```

8 +Windows 10 or later (64-bit), x86-64 based

9 +Flutter 3.19.x

10 +```

11 +

12 +### 1. Installing Flutter

13 +

14 +Install Flutter with version `3.19.x`. Follow the Flutter [installation guide](https://docs.flutter.dev/get-started/install/windows).

15 +

16 +### 2. Install Development Tools

17 +

18 +Install Git for Windows and Visual Studio 2022. Follow the [Development Tools](https://docs.flutter.dev/get-started/install/windows/desktop#development-tools) installation instructions.

19 +

20 +Then install `Desktop development with C++` packages via Visual Studio 2022, or Visual Studio Build Tools 2022 including:

21 +- `C++ Build Tools core features`

22 +- `C++ 2022 Redistributable Update`

23 +- `C++ core desktop features`

24 +- `MVC v143 - VS 2022 C++ x64/x86 build tools`

25 +- `C++ CMake tools for Windwos`

26 +- `Testing tools core features - Build Tools`

27 +- `C++ AddressSanitizer`.

28 +

29 +### 3. Installing rustup

30 +

31 +Install rustup from the [rustup.rs](https://rustup.rs/#) website. Download and run the 64-bit rustup-init.exe

32 +

33 +### 4. Installing WSL (Windows Subsystem for Linux)

34 +

35 +For building monero dependencies, it is required to install Windows WSL (https://learn.microsoft.com/en-us/windows/wsl/install) and required packages for WSL (Ubuntu):

36 +`$ sudo apt update `

37 +`$ sudo apt build-essential cmake gcc-mingw-w64 g++-mingw-w64 autoconf libtool pkg-config`

38 +

39 +### 5. Pull Cake Wallet source code

40 +

41 +You can downlaod CakeWallet source code from our [GitHub repository](github.com/cake-tech/cake_wallet) via git:

42 +`$ git clone https://github.com/cake-tech/cake_wallet.git --branch MrCyjaneK-cyjan-monerodart`

43 +OR you can download it as [Zip archive](https://github.com/cake-tech/cake_wallet/archive/refs/heads/MrCyjaneK-cyjan-monerodart.zip)

44 +

45 +### 6. Build Monero, monero_c and their dependencies

46 +

47 +To use Monero in Cake Wallet, you must build the Monero_C wrapper which will be used by monero.dart package.

48 +

49 +For that you need to run the shell (bash - typically same named utility should be available after WSL is enabled in your system) with the previously installed WSL install, then change current directory to the application project directory with your shell then change current directory to `scripts/windows`: `$ cd scripts/windows`. Run build script: `$ ./build_all.sh`.

50 +

51 +### 7. Configure and build Cake Wallet application

52 +

53 +To configure the application, open the directory where you have downloaded or unarchived Cake Wallet sources and run `cakewallet.bat`.

54 +Or if you used WSL and have active shell session you can run `$ ./cakewallet.sh` script in `scripts/windows` which will run `cakewallet.bat` in WSL.

55 +After execution of `cakewallet.bat` you should to get `Cake Wallet.zip` in project root directory which will contains `CakeWallet.exe` file and another needed files for run the application. Now you can extract files from `Cake Wallet.zip` archive and run the application.

56 +