Ecosystem/feather
Ecosystem/feather
1
0
Fork 0
mirror of https://github.com/feather-wallet/feather.git synced 2024-12-22 19:49:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update HACKING.md

Browse source
This commit is contained in:
tobtoht 2024-10-03 16:28:34 +02:00
parent bd0d1cfe76
commit 7c1f43ce7c
No known key found for this signature in database
GPG key ID: E45B10DD027D2472
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
HACKING.md
View file

@ -1,29 +1,26 @@
# Documentation for developers # Documentation for developers
Feather is developed primarily on Linux, but can also be built and debugged on macOS. Development on Windows is not Feather is developed primarily on Linux, but can also be built on macOS. Development on Windows is not currently supported.
currently supported.
We support development on rolling release distributions and the latest version of Ubuntu. Building on older stable distributions is not guaranteed to work.
## Setting up a development environment ## Setting up a development environment
### Dependencies ### Dependencies
Note: Feather requires Qt 6.3 or later. Make sure your distro's package manager provides this version.
If not, it is recommended that you install Qt manually using the online installer, which can be found here:
https://www.qt.io/download (under open-source).
#### Arch Linux #### Arch Linux
```bash ```bash
pacman -S git cmake base-devel ccache unbound boost qrencode qt6-base qt6-svg qt6-websockets qt6-multimedia libzip hidapi protobuf zxing-cpp pacman -S git cmake base-devel ccache unbound boost qrencode qt6-base qt6-svg qt6-websockets qt6-multimedia libzip hidapi protobuf zxing-cpp
``` ```
#### Ubuntu 22.04 #### Ubuntu 24.04
```bash ```bash
apt update apt update
apt install git cmake build-essential ccache libssl-dev libunbound-dev libboost-all-dev libqrencode-dev \ apt install git cmake build-essential ccache libssl-dev libunbound-dev libboost-all-dev libqrencode-dev \
qt6-base-dev libgl1-mesa-dev libqt6svg6-dev libqt6websockets6-dev libzip-dev libsodium-dev libgcrypt-dev \ qt6-base-dev qt6-multimedia-dev libgl1-mesa-dev libqt6svg6-dev libqt6websockets6-dev libzip-dev libsodium-dev libgcrypt-dev \
libx11-xcb-dev libprotobuf-dev libhidapi-dev libzxing-dev libx11-xcb-dev libprotobuf-dev protobuf-compiler libhidapi-dev libzxing-dev
``` ```
#### Void Linux #### Void Linux
@ -92,9 +89,8 @@ git submodule update --init --recursive
We recommend using Jetbrains Clion for Feather development. It integrates nicely with CMake and comes with a built-in We recommend using Jetbrains Clion for Feather development. It integrates nicely with CMake and comes with a built-in
debugger. debugger.
To pass CMake flags to CLion, go to `File->Settings->Build->CMake`, set Build Type to `Debug` and set your To pass CMake flags to CLion, go to `File -> Settings -> Build -> CMake`, set Build Type to `Debug` and set your
preferred CMake options. If you installed Qt using the online installer you may have to add preferred CMake options. More CMake options are documented below.
`-DCMAKE_PREFIX_PATH=/path/to/qt/installation` in the CMake options. More CMake options are documented below.
Run CMake (`View -> Tool Windows -> CMake`). Click on the 🔃 (`Reload CMake Project`) button. Run CMake (`View -> Tool Windows -> CMake`). Click on the 🔃 (`Reload CMake Project`) button.