mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-27 11:43:26 -03:00
5d1f260713
The current readme is a little bit outdated and contains some grammatical mistakes. This commit updates the doc so that: - It is easier to follow and is more informative - Fixes grammatical mistakes - Modernizes the Qt Creater setup instructions - Adds UNIX instructions for Qt Creator setup |
||
|---|---|---|
| .. | ||
| forms | ||
| locale | ||
| res | ||
| test | ||
| addressbookpage.cpp | ||
| addressbookpage.h | ||
| addresstablemodel.cpp | ||
| addresstablemodel.h | ||
| askpassphrasedialog.cpp | ||
| askpassphrasedialog.h | ||
| bantablemodel.cpp | ||
| bantablemodel.h | ||
| bitcoin.cpp | ||
| bitcoin.h | ||
| bitcoin.qrc | ||
| bitcoin_locale.qrc | ||
| bitcoinaddressvalidator.cpp | ||
| bitcoinaddressvalidator.h | ||
| bitcoinamountfield.cpp | ||
| bitcoinamountfield.h | ||
| bitcoingui.cpp | ||
| bitcoingui.h | ||
| bitcoinstrings.cpp | ||
| bitcoinunits.cpp | ||
| bitcoinunits.h | ||
| clientmodel.cpp | ||
| clientmodel.h | ||
| coincontroldialog.cpp | ||
| coincontroldialog.h | ||
| coincontroltreewidget.cpp | ||
| coincontroltreewidget.h | ||
| createwalletdialog.cpp | ||
| createwalletdialog.h | ||
| csvmodelwriter.cpp | ||
| csvmodelwriter.h | ||
| editaddressdialog.cpp | ||
| editaddressdialog.h | ||
| guiconstants.h | ||
| guiutil.cpp | ||
| guiutil.h | ||
| intro.cpp | ||
| intro.h | ||
| macdockiconhandler.h | ||
| macdockiconhandler.mm | ||
| macnotificationhandler.h | ||
| macnotificationhandler.mm | ||
| macos_appnap.h | ||
| macos_appnap.mm | ||
| main.cpp | ||
| Makefile | ||
| modaloverlay.cpp | ||
| modaloverlay.h | ||
| networkstyle.cpp | ||
| networkstyle.h | ||
| notificator.cpp | ||
| notificator.h | ||
| openuridialog.cpp | ||
| openuridialog.h | ||
| optionsdialog.cpp | ||
| optionsdialog.h | ||
| optionsmodel.cpp | ||
| optionsmodel.h | ||
| overviewpage.cpp | ||
| overviewpage.h | ||
| paymentserver.cpp | ||
| paymentserver.h | ||
| peertablemodel.cpp | ||
| peertablemodel.h | ||
| platformstyle.cpp | ||
| platformstyle.h | ||
| psbtoperationsdialog.cpp | ||
| psbtoperationsdialog.h | ||
| qrimagewidget.cpp | ||
| qrimagewidget.h | ||
| qvalidatedlineedit.cpp | ||
| qvalidatedlineedit.h | ||
| qvaluecombobox.cpp | ||
| qvaluecombobox.h | ||
| README.md | ||
| receivecoinsdialog.cpp | ||
| receivecoinsdialog.h | ||
| receiverequestdialog.cpp | ||
| receiverequestdialog.h | ||
| recentrequeststablemodel.cpp | ||
| recentrequeststablemodel.h | ||
| rpcconsole.cpp | ||
| rpcconsole.h | ||
| sendcoinsdialog.cpp | ||
| sendcoinsdialog.h | ||
| sendcoinsentry.cpp | ||
| sendcoinsentry.h | ||
| sendcoinsrecipient.h | ||
| signverifymessagedialog.cpp | ||
| signverifymessagedialog.h | ||
| splashscreen.cpp | ||
| splashscreen.h | ||
| trafficgraphwidget.cpp | ||
| trafficgraphwidget.h | ||
| transactiondesc.cpp | ||
| transactiondesc.h | ||
| transactiondescdialog.cpp | ||
| transactiondescdialog.h | ||
| transactionfilterproxy.cpp | ||
| transactionfilterproxy.h | ||
| transactionrecord.cpp | ||
| transactionrecord.h | ||
| transactiontablemodel.cpp | ||
| transactiontablemodel.h | ||
| transactionview.cpp | ||
| transactionview.h | ||
| utilitydialog.cpp | ||
| utilitydialog.h | ||
| walletcontroller.cpp | ||
| walletcontroller.h | ||
| walletframe.cpp | ||
| walletframe.h | ||
| walletmodel.cpp | ||
| walletmodel.h | ||
| walletmodeltransaction.cpp | ||
| walletmodeltransaction.h | ||
| walletview.cpp | ||
| walletview.h | ||
| winshutdownmonitor.cpp | ||
| winshutdownmonitor.h | ||
This directory contains the source code for the Bitcoin Core graphical user interface (GUI). It uses the Qt cross-platform framework.
The current precise version for Qt 5 is specified in qt.mk.
Compile and run
See build instructions: Unix, macOS, Windows, FreeBSD, NetBSD, OpenBSD
When following your systems build instructions, make sure to install the Qt dependencies.
To run:
./src/qt/bitcoin-qt
Files and Directories
forms/
- A directory that contains Designer UI files. These files specify the characteristics of form elements in XML. Qt UI files can be edited with Qt Creator or using any text editor.
locale/
- Contains translations. They are periodically updated and an effort is made to support as many languages as possible. The process of contributing translations is described in doc/translation_process.md.
res/
- Contains graphical resources used to enhance the UI experience.
test/
- Functional tests used to ensure proper functionality of the GUI. Significant changes to the GUI code normally require new or updated tests.
bitcoingui.(h/cpp)
- Represents the main window of the Bitcoin UI.
*model.(h/cpp)
- The model. When it has a corresponding controller, it generally inherits from QAbstractTableModel. Models that are used by controllers as helpers inherit from other Qt classes like QValidator.
- ClientModel is used by the main application
bitcoinguiand several models likepeertablemodel.
*page.(h/cpp)
- A controller.
:NAMEpage.cppgenerally includes:NAMEmodel.handforms/:NAME.page.uiwith a similar:NAME.
*dialog.(h/cpp)
- Various dialogs, e.g. to open a URL. Inherit from QDialog.
paymentserver.(h/cpp)
- (Deprecated) Used to process BIP21 payment URI requests. Also handles URI-based application switching (e.g. when following a bitcoin:... link from a browser).
walletview.(h/cpp)
- Represents the view to a single wallet.
Other .h/cpp files
- UI elements like BitcoinAmountField, which inherit from QWidget.
bitcoinstrings.cpp: automatically generatedbitcoinunits.(h/cpp): BTC / mBTC / etc. handlingcallback.hguiconstants.h: UI colors, app name, etc.guiutil.h: several helper functionsmacdockiconhandler.(h/mm): macOS dock icon handlermacnotificationhandler.(h/mm): display notifications in macOS
Contribute
See CONTRIBUTING.md for general guidelines.
Note: Do not change local/bitcoin_en.ts. It is updated automatically.
Using Qt Creator as an IDE
Qt Creator is a powerful tool which packages a UI designer tool (Qt Designer) and a C++ IDE into one application. This is especially useful if you want to change the UI layout.
Download Qt Creator
On Unix and macOS, Qt Creator can be installed through your package manager. Alternatively, you can download a binary from the Qt Website.
Note: If installing from a binary grabbed from the Qt Website: During the installation process, uncheck everything except for Qt Creator.
macOS
brew install qt-creator
Ubuntu & Debian
sudo apt-get install qtcreator
Setup Qt Creator
- Make sure you've installed all dependencies specified in your systems build instructions
- Follow the compile instructions for your system, run
./configurewith the--enable-debugflag - Start Qt Creator. At the start page, do:
New->Import Project->Import Existing Project - Enter
bitcoin-qtas the Project Name and enter the absolute path tosrc/qtas Location - Check over the file selection, you may need to select the
formsdirectory (necessary if you intend to edit *.ui files) - Confirm the
Summarypage - In the
Projectstab, selectManage Kits...
macOS
- Under
Kits: select the default "Desktop" kit - Under
Compilers: select"Clang (x86 64bit in /usr/bin)" - Under
Debuggers: select"LLDB"as debugger (you might need to set the path to your LLDB installation)
Ubuntu & Debian
Note: Some of these options may already be set
- Under
Kits: select the default "Desktop" kit - Under
Compilers: select"GCC (x86 64bit in /usr/bin)" - Under
Debuggers: select"GDB"as debugger
- While in the
Projectstab, ensure that you have thebitcoin-qtexecutable specified underRun
- If the executable is not specified: click
"Choose...", navigate tosrc/qt, and selectbitcoin-qt
- You're all set! Start developing, building, and debugging the Bitcoin Core GUI