WARNING: THIS IS EXPERIMENTAL, DO NOT USE BUILDS FROM THIS REPO FOR REAL TRANSACTIONS!
This directory contains the source code for an experimental Bitcoin Core graphical user interface (GUI) built using the Qt Quick framework.
The current Bitcoin Core GUI has gathered enough technical debt and hacked on features; it is time to begin anew. This project will start from a clean slate to produce a feature-rich GUI with intuitive user flows and first-class design.
The primary goals of the project can be summed up as follows:
- Implement UX/UI best-practices as documented in the Bitcoin Design Guide
- Engage with the Bitcoin Design community to implement well-designed features
- Work alongside the Bitcoin Design community to develop an aesthetic GUI
- Develop a mobile-optimized GUI
It is important that we stay as conflict-free as possible with the Bitcoin Core repo. As such, this project will aim to make very few changes outside of the qml directory. Pull requests must be focused on developing the GUI itself, adding build support, or improving relevant documentation.
Note that this project will not accept pull requests making any significant changes unrelated to the GUI.
This repo is synced with the Bitcoin Core repo on a weekly basis, or as needed to resolve conflicts.
Contributions are welcome from all, developers and designers. If you are a new contributor, please read CONTRIBUTING.md.
All development must adhere to the current upstream Qt Version to minimize our divergence from upstream and avoid costly changes. Review of open PR's must ensure that changes are compatible with this Qt version. Currently, the required version is Qt 5.12.11.
As the Qt Version changes upstream, refactoring is allowed to use the now available features.
The master branch is only guaranteed to work and build on Debian-based systems and macOS. Support for more systems will be confirmed and documented as the project matures.
Aside from the dependencies listed in build-unix.md, Debian based systems require the following additional dependencies to compile:
sudo apt install qtdeclarative5-dev qtquickcontrols2-5-dev
The following runtime dependencies are also required for dynamic builds; they are not needed for static builds:
sudo apt install qml-module-qtquick2 qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qtquick-dialogs qml-module-qtquick-window2
No additional dependencies, besides those in build-osx.md, are needed for macOS.
For instructions on how to build and compile Bitcoin Core, refer to your respective systems build docs.
To add support for building the qml GUI, you must configure with the following option:
./configure --with-qml