Skip to content

Commit a566d43

Browse files
committed
Merge #7: doc: introduce qml/README.md
605842a doc: introduce qml/README.md (Jarol Rodriguez) Pull request description: This introduces a `README.md` for the new `qml` directory. 🥳 [qml/README.md render](605842a) It outlines the goals and limitations of the projects and stages for future development and build notes. Looking for concept ACK/NACKS and what's been included and feedback on what else to add. Naturally, this document will evolve as we continue to work on the project. Closes #1 Closes #3 ACKs for top commit: hebasto: ACK 605842a Tree-SHA512: f9e3ce7510c03bb001bf58f2650e1e7c9ee0eae5d1349d9b7ad275b840a6dd9eceadd1a79468efd8751af9ecb6fd15bacf19d6a238303a61a31c42bbb0251497
2 parents 5834544 + 605842a commit a566d43

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

src/qml/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Bitcoin Core QML GUI
2+
3+
**WARNING: THIS IS EXPERIMENTAL, DO NOT USE BUILDS FROM THIS REPO FOR REAL TRANSACTIONS!**
4+
5+
This directory contains the source code for an experimental Bitcoin Core graphical user interface (GUI) built using the [Qt Quick](https://doc.qt.io/qt-5/qtquick-index.html) framework.
6+
7+
# Goals and Limitations
8+
9+
The current Bitcoin Core GUI has gathered enough technical debt and hacked on features; it is time to begin anew.
10+
This project will start from a clean slate to produce a feature-rich GUI with intuitive user flows and first-class design.
11+
12+
The primary goals of the project can be summed up as follows:
13+
14+
- Implement UX/UI best-practices as documented in the [Bitcoin Design Guide](https://bitcoin.design/guide/)
15+
- Engage with the Bitcoin Design community to implement well-designed features
16+
- Work alongside the Bitcoin Design community to develop an aesthetic GUI
17+
- Develop a mobile-optimized GUI
18+
19+
It is important that we stay as conflict-free as possible with the Bitcoin Core repo.
20+
As such, this project will aim to make very few changes outside of the qml directory.
21+
Pull requests must be focused on developing the GUI itself, adding build support,
22+
or improving relevant documentation.
23+
24+
Note that this project will **not** accept pull requests making any significant changes unrelated to the GUI.
25+
26+
# Development Process
27+
28+
This repo is synced with the [Bitcoin Core repo](https://github.com/bitcoin/bitcoin) on a weekly basis, or as needed to resolve conflicts.
29+
30+
Contributions are welcome from all, developers and designers. If you are a new contributor, please read [CONTRIBUTING.md](../../CONTRIBUTING.md).
31+
32+
# Compile and Run
33+
34+
The master branch is only guaranteed to work and build on Debian-based systems and macOS.
35+
Support for more systems will be confirmed and documented as the project matures.
36+
37+
### Dependencies
38+
Aside from the dependencies listed in [build-unix.md](../../doc/build-unix.md), Debian based systems require the following additional dependencies:
39+
40+
```
41+
sudo apt install qtdeclarative5-dev qtquickcontrols2-5-dev
42+
```
43+
44+
No additional dependencies, besides those in [build-osx.md](../../doc/build-osx.md), are needed for macOS.
45+
46+
### Build
47+
48+
For instructions on how to build and compile Bitcoin Core, refer to your respective systems build docs.
49+
50+
To add support for building the qml GUI,
51+
you must configure with the following option:
52+
53+
```
54+
./configure --with-qml
55+
```

0 commit comments

Comments
 (0)