Skip to content

Commit

Permalink
Merge #14: doc: introduce qml/README.md
Browse files Browse the repository at this point in the history
605842a doc: introduce qml/README.md (Jarol Rodriguez)

Pull request description:

  This is a duplicate of #7 because it had been lost, R.I.P 😔.

  **Original PR 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.

ACKs for top commit:
  hebasto:
    ACK 605842a, verified all of the links.

Tree-SHA512: c02fb39127ffd438a4a2e4ec762a8fb80f79c78227c4aef5b485d49624f4936f533eb7eaff208a1ebc3308957a721b94ecc7bab1e6f5296c13115fe98f567c26
  • Loading branch information
hebasto committed Jul 24, 2021
2 parents 4d7ce14 + 605842a commit 25d0f47
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions src/qml/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Bitcoin Core QML GUI

**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](https://doc.qt.io/qt-5/qtquick-index.html) framework.

# Goals and Limitations

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](https://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.

# Development Process

This repo is synced with the [Bitcoin Core repo](https://github.com/bitcoin/bitcoin) 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](../../CONTRIBUTING.md).

# Compile and Run

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.

### Dependencies
Aside from the dependencies listed in [build-unix.md](../../doc/build-unix.md), Debian based systems require the following additional dependencies:

```
sudo apt install qtdeclarative5-dev qtquickcontrols2-5-dev
```

No additional dependencies, besides those in [build-osx.md](../../doc/build-osx.md), are needed for macOS.

### Build

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
```

0 comments on commit 25d0f47

Please sign in to comment.