|
|
|
|
@ -1,17 +1,25 @@
|
|
|
|
|
# Documentation for developers
|
|
|
|
|
|
|
|
|
|
Feather is developed primarily on Linux. It uses Qt 5.15.* and chances are that your
|
|
|
|
|
WOWlet is developed primarily on Linux. It uses Qt 5.15.* and chances are that your
|
|
|
|
|
distro's package manager has a lower version. It is therefore recommended that you install
|
|
|
|
|
Qt manually using the online installer, which can be found here: https://www.qt.io/download
|
|
|
|
|
(under open-source).
|
|
|
|
|
|
|
|
|
|
## Jetbrains Clion
|
|
|
|
|
|
|
|
|
|
Feather was developed using JetBrains Clion since it integrates nicely
|
|
|
|
|
WOWlet was developed using JetBrains Clion since it integrates nicely
|
|
|
|
|
with CMake and comes with a built-in debugger. To pass CMake flags to CLion,
|
|
|
|
|
go to `File->Settings->Build->CMake`, set Build Type to `Debug` and set your
|
|
|
|
|
preferred CMake options/definitions.
|
|
|
|
|
|
|
|
|
|
## Man Page
|
|
|
|
|
|
|
|
|
|
There is a WOWlet's manual page, which can be accessed with: `man wowlet`
|
|
|
|
|
|
|
|
|
|
If a new option is introduced, please be sure to update the options section in
|
|
|
|
|
`src/assets/wowlet.1.md`, the month and year in line 3, and "manify" the document
|
|
|
|
|
by running this command: `pandoc wowlet.1.md -s -t man -o wowlet.1 && gzip wowlet.1`
|
|
|
|
|
|
|
|
|
|
## Requirements
|
|
|
|
|
|
|
|
|
|
### Ubuntu/Debian
|
|
|
|
|
@ -33,16 +41,16 @@ protobuf libgcrypt qrencode ccache cmake pkgconfig git
|
|
|
|
|
## CMake
|
|
|
|
|
|
|
|
|
|
After installing Qt you might have a folder called `/home/$user/Qt/`. You need to pass this to CMake
|
|
|
|
|
via the `CMAKE_PREFIX_PATH` definition. For me this is:
|
|
|
|
|
via the `CMAKE_PREFIX_PATH` definition.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
-DCMAKE_PREFIX_PATH=/home/dsc/QtNew/5.15.0/gcc_64
|
|
|
|
|
-DCMAKE_PREFIX_PATH=/home/$user/QtNew/5.15.0/gcc_64
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
There are some Monero/Feather related options/definitions that you may pass:
|
|
|
|
|
There are some Wownero/WOWlet related options/definitions that you may pass:
|
|
|
|
|
|
|
|
|
|
- `-DXMRIG=OFF` - disable XMRig feature
|
|
|
|
|
- `-DTOR_BIN=/path/to/tor` - Embed a Tor executable inside Feather
|
|
|
|
|
- `-DTOR_BIN=/path/to/tor` - Embed a Tor executable inside WOWlet
|
|
|
|
|
- `-DDONATE_BEG=OFF` - disable the dreaded donate requests
|
|
|
|
|
|
|
|
|
|
And:
|
|
|
|
|
@ -74,9 +82,9 @@ Enable debugging symbols:
|
|
|
|
|
-DCMAKE_BUILD_TYPE=Debug
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Feather
|
|
|
|
|
## Wowlet
|
|
|
|
|
|
|
|
|
|
It's best to install Tor locally as a service and start Feather with `--use-local-tor`, this
|
|
|
|
|
It's best to install Tor locally as a service and start `wowlet` with `--use-local-tor`, this
|
|
|
|
|
prevents the child process from starting up and saves time.
|
|
|
|
|
|
|
|
|
|
#### Ubuntu/Debian
|
|
|
|
|
@ -96,9 +104,9 @@ brew services start tor
|
|
|
|
|
To skip the wizards and open a wallet directly use `--wallet-file`:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
./feather --use-local-tor --wallet-file /home/user/Monero/wallets/bla.keys
|
|
|
|
|
./wowlet --use-local-tor --wallet-file /home/user/Wownero/wallets/bla.keys
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
It is recommended that you use `--stagenet` for development. Testnet is also possible,
|
|
|
|
|
but you'll have to provide Feather a testnet node of your own.
|
|
|
|
|
but you'll have to provide Wownero a testnet node of your own.
|
|
|
|
|
|
|
|
|
|
|
