move qml/README to front page

Author: pinheadmz

README.md

@@ -0,0 +1,101 @@
+# 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.
+
+Unsecure CI artifacts are available for local testing of the master branch, avoiding the need to build. These can be found under the [Actions](https://github.com/bitcoin-core/gui-qml/actions?query=branch%3Amain) tab. It is required to have and be logged into a github account in order to download these.
+
+Note: For macOS, the CI artifact binary must be made executable and code-signed before it can
+be ran. To make executable and apply a signature, run the following on the unzipped CI artifact:
+
+```
+chmod +x ./Downloads/bitcoin-qt && codesign -s - ./Downloads/bitcoin-qt
+```
+
+## 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
+
+We must avoid conflicts 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.
+
+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).
+
+### Minimum Required Qt Version
+
+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.15.2](https://github.com/bitcoin-core/gui-qml/blob/main/depends/packages/qt.mk#L2).
+
+As the Qt Version changes upstream, refactoring is allowed to use the now available features.
+
+### Policies
+
+This project has custom policies for development, see:
+- [Icon Policy](./doc/icon-policy.md)
+- [Translator Comments Policy](./doc/translator-comments.md)
+
+## Compile and Run
+
+The master branch is only guaranteed to work and build on Debian-based systems, Fedora, and macOS.
+Support for more systems will be confirmed and documented as the project matures.
+
+### Dependencies
+No additional dependencies, besides those in [build-osx.md](../../doc/build-osx.md), are needed for macOS.
+
+Aside from the dependencies listed in [build-unix.md](../../doc/build-unix.md), the following additional dependencies are required to compile:
+
+#### Debian-based systems:
+
+```
+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-layouts qml-module-qtquick-window2 qml-module-qt-labs-settings
+```
+##### Important:
+
+If you're unable to install the dependencies through your system's package manager, you can instead perform a [depends build](../../depends/README.md).
+
+#### Fedora:
+
+```
+sudo dnf install qt5-qtdeclarative-devel qt5-qtquickcontrols qt5-qtquickcontrols2-devel
+```
+
+### Build
+
+For instructions on how to build and compile Bitcoin Core, refer to your respective system's build doc.
+
+As long as the required dependencies are installed, the qml GUI will be built.
+To ensure that you are in fact building the qml GUI, you can configure with the following option:
+
+```
+./configure --with-qml
+```
+
+### Run
+
+To run the qml GUI:
+```
+./src/qt/bitcoin-qt
+```