2017-03-09 19:03:12 +00:00
# Monero GUI
2017-03-07 21:01:32 +00:00
Copyright (c) 2014-2017, The Monero Project
2015-04-01 08:58:06 +00:00
## Development Resources
2016-10-09 13:12:01 +00:00
- Web: [getmonero.org ](https://getmonero.org )
- Forum: [forum.getmonero.org ](https://forum.getmonero.org )
- Mail: [dev@getmonero.org ](mailto:dev@getmonero.org )
- Github: [https://github.com/monero-project/monero-core ](https://github.com/monero-project/monero-core )
- IRC: [#monero-dev on Freenode ](irc://chat.freenode.net/#monero-dev )
2015-04-01 08:58:06 +00:00
## Introduction
2016-10-09 13:12:01 +00:00
Monero is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.
2015-04-01 08:58:06 +00:00
**Privacy:** Monero uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private by default.
2016-10-09 13:12:01 +00:00
**Security:** Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.
2015-04-01 08:58:06 +00:00
2016-10-09 13:12:01 +00:00
**Untraceability:** By taking advantage of ring signatures, a special property of a certain type of cryptography, Monero is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.
2015-04-01 08:58:06 +00:00
## About this Project
2016-10-09 13:12:01 +00:00
This is the GUI for the [core Monero implementation ](https://github.com/monero-project/monero ). It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Monero that uses the protocol and network in a compatible manner.
2015-04-01 08:58:06 +00:00
2016-10-09 13:12:01 +00:00
As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.
2015-04-01 08:58:06 +00:00
## Supporting the Project
Monero development can be supported directly through donations.
Both Monero and Bitcoin donations can be made to donate.getmonero.org if using a client that supports the [OpenAlias ](https://openalias.org ) standard
2016-10-09 13:12:01 +00:00
The Monero donation address is: `44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A` (viewkey: `f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501` )
2015-04-01 08:58:06 +00:00
2016-10-09 13:12:01 +00:00
The Bitcoin donation address is: `1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H`
2015-04-01 08:58:06 +00:00
Core development funding and/or some supporting services are also graciously provided by sponsors:
2016-09-03 08:04:30 +00:00
[<img width="80" src="https://static.getmonero.org/images/sponsors/mymonero.png"/> ](https://mymonero.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/kitware.png?1"/> ](http://kitware.com )
[<img width="100" src="https://static.getmonero.org/images/sponsors/dome9.png"/> ](http://dome9.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/araxis.png"/> ](http://araxis.com )
[<img width="150" src="https://static.getmonero.org/images/sponsors/jetbrains.png"/> ](http://www.jetbrains.com/ )
2016-10-09 13:12:01 +00:00
[<img width="150" src="https://static.getmonero.org/images/sponsors/navicat.png"/> ](http://www.navicat.com/ )
[<img width="150" src="https://static.getmonero.org/images/sponsors/symas.png"/> ](http://www.symas.com/ )
2015-04-01 08:58:06 +00:00
There are also several mining pools that kindly donate a portion of their fees, [a list of them can be found on our Bitcointalk post ](https://bitcointalk.org/index.php?topic=583449.0 ).
## License
2016-09-03 08:03:05 +00:00
See [LICENSE ](LICENSE ).
2016-07-04 15:25:03 +00:00
2016-10-09 13:13:50 +00:00
## Installing Monero Core from a Package
2016-07-04 15:25:03 +00:00
2016-09-03 08:07:20 +00:00
Packages are available for
2016-07-04 15:25:03 +00:00
2016-09-03 08:07:20 +00:00
* Arch Linux via AUR: [monero-core-git ](https://aur.archlinux.org/packages/monero-core-git/ )
2016-07-04 15:25:03 +00:00
2016-09-03 08:07:20 +00:00
Packaging for your favorite distribution would be a welcome contribution!
2016-07-04 15:25:03 +00:00
2016-10-09 13:13:50 +00:00
## Compiling Monero Core from Source
2016-09-03 08:07:20 +00:00
2016-07-04 15:25:03 +00:00
### On Linux:
2016-08-20 17:59:52 +00:00
2017-03-29 08:40:09 +00:00
(Tested on Ubuntu 16.04 x86, 16.10 x64, Gentoo x64 and Linux Mint 18 "Sarah" - Cinnamon x64)
2016-08-20 17:59:52 +00:00
2017-05-15 02:44:48 +00:00
1. Install Monero dependencies
2016-08-20 17:59:52 +00:00
2017-03-29 08:40:09 +00:00
- For Ubuntu and Mint
2016-11-05 03:10:55 +00:00
`sudo apt install build-essential cmake libboost-all-dev miniupnpc libunbound-dev graphviz doxygen libunwind8-dev pkg-config libssl-dev`
2016-08-20 17:59:52 +00:00
2017-03-29 08:40:09 +00:00
- For Gentoo
`sudo emerge app-arch/xz-utils app-doc/doxygen dev-cpp/gtest dev-libs/boost dev-libs/expat dev-libs/openssl dev-util/cmake media-gfx/graphviz net-dns/unbound net-libs/ldns net-libs/miniupnpc sys-libs/libunwind`
2017-05-15 02:44:48 +00:00
2. Grab an up-to-date copy of the monero-core repository
2016-08-20 17:59:52 +00:00
2016-11-05 03:10:55 +00:00
`git clone https://github.com/monero-project/monero-core.git`
2016-08-20 17:59:52 +00:00
2017-05-15 02:44:48 +00:00
3. Go into the repository
2016-08-20 17:59:52 +00:00
2016-11-05 03:10:55 +00:00
`cd monero-core`
2016-08-20 17:59:52 +00:00
2017-05-15 02:44:48 +00:00
4. Install the GUI dependencies
2016-08-20 17:59:52 +00:00
2017-03-11 18:35:27 +00:00
- For Ubuntu 16.04 x86
2016-08-21 19:03:26 +00:00
2017-03-23 00:21:34 +00:00
`sudo apt-get install qtbase5-dev qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-xmllistmodel qttools5-dev-tools qml-module-qtquick-dialogs`
2016-08-20 17:59:52 +00:00
2017-03-11 18:35:27 +00:00
- For Ubuntu 16.04+ x64
2016-11-09 07:55:31 +00:00
2017-03-29 08:40:09 +00:00
`sudo apt-get install qtbase5-dev qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-xmllistmodel qttools5-dev-tools qml-module-qtquick-dialogs qml-module-qt-labs-settings libqt5qml-graphicaleffects`
2016-10-05 23:15:15 +00:00
2017-03-11 18:35:27 +00:00
- For Linux Mint 18 "Sarah" - Cinnamon x64
2016-08-21 19:03:26 +00:00
2017-03-29 08:40:09 +00:00
`sudo apt install qml-module-qt-labs-settings qml-module-qtgraphicaleffects`
- For Gentoo
`sudo emerge dev-qt/qtcore:5 dev-qt/qtdeclarative:5 dev-qt/qtquickcontrols:5 dev-qt/qtgraphicaleffects:5`
2016-08-21 19:03:26 +00:00
2017-03-27 17:49:54 +00:00
- Optional : To build the flag `WITH_SCANNER`
2017-03-29 08:40:09 +00:00
- For Ubuntu and Mint
`sudo apt install qtmultimedia5-dev qml-module-qtmultimedia libzbar-dev`
- For Gentoo
The *qml* USE flag must be enabled.
`emerge dev-qt/qtmultimedia:5 media-gfx/zbar`
2017-03-27 17:49:54 +00:00
2017-05-15 02:44:48 +00:00
5. Build the GUI
2016-08-20 17:59:52 +00:00
2017-03-29 08:40:09 +00:00
- For Ubuntu and Mint
2016-12-22 16:41:03 +00:00
`./build.sh`
2016-08-20 17:59:52 +00:00
2017-03-29 08:40:09 +00:00
- For Gentoo
`QT_SELECT=5 ./build.sh`
2017-05-15 02:44:48 +00:00
The executable can be found in the build/release/bin folder.
2016-07-04 15:25:03 +00:00
### On OS X:
2016-10-09 13:12:01 +00:00
2016-11-09 07:55:31 +00:00
1. Install Xcode from AppStore
2. Install [homebrew ](http://brew.sh/ )
3. Install [monero ](https://github.com/monero-project/monero ) dependencies:
2017-03-09 19:03:12 +00:00
`brew install boost --c++11`
`brew install openssl` - to install openssl headers
`brew install pkgconfig`
2016-11-09 07:55:31 +00:00
2017-03-09 19:03:12 +00:00
`brew install cmake`
2016-11-09 07:55:31 +00:00
2017-03-09 19:03:12 +00:00
`brew install qt5` (or download QT 5.8+ from [qt.io ](https://www.qt.io/download-open-source/ ))
2016-11-09 07:55:31 +00:00
2017-03-09 19:03:12 +00:00
If you have an older version of Qt installed via homebrew, you can force it to use 5.x like so:
2017-03-25 16:22:13 +00:00
2017-03-09 19:03:12 +00:00
`brew link --force --overwrite qt5`
2016-11-09 07:55:31 +00:00
2017-04-25 05:09:43 +00:00
5. Add the Qt bin directory to your path
2016-11-09 07:55:31 +00:00
2017-04-25 05:09:43 +00:00
Example: `export PATH=$PATH:$HOME/Qt/5.8/clang_64/bin`
2016-11-09 07:55:31 +00:00
2017-04-25 05:09:43 +00:00
This is the directory where Qt 5.x is installed on **your** system
2016-11-09 07:55:31 +00:00
2017-05-15 02:44:48 +00:00
6. Grab an up-to-date copy of the monero-core repository
2016-11-09 07:55:31 +00:00
2017-03-09 19:03:12 +00:00
`git clone https://github.com/monero-project/monero-core.git`
2016-11-09 07:55:31 +00:00
2017-05-15 02:44:48 +00:00
7. Go into the repository
2016-11-09 07:55:31 +00:00
2017-03-09 19:03:12 +00:00
`cd monero-core`
2016-11-09 07:55:31 +00:00
2017-05-15 02:44:48 +00:00
8. Start the build
2016-11-18 00:11:49 +00:00
`./build.sh`
2016-11-09 07:55:31 +00:00
The executable can be found in the `build/release/bin` folder.
2016-12-04 19:21:14 +00:00
**Note:** Workaround for "ERROR: Xcode not set up properly"
2017-05-15 02:44:48 +00:00
Edit `$HOME/Qt/5.8/clang_64/mkspecs/features/mac/default_pre.prf`
2016-12-04 19:21:14 +00:00
replace
`isEmpty($$list($$system("/usr/bin/xcrun -find xcrun 2>/dev/null")))`
with
`isEmpty($$list($$system("/usr/bin/xcrun -find xcodebuild 2>/dev/null")))`
More info: http://stackoverflow.com/a/35098040/1683164
2016-07-04 15:25:03 +00:00
### On Windows:
2016-10-09 13:12:01 +00:00
2016-10-12 21:10:00 +00:00
1. Install [msys2 ](http://msys2.github.io/ ), follow the instructions on that page on how to update packages to the latest versions
2017-03-04 04:17:23 +00:00
2017-05-15 02:44:48 +00:00
2. Install monero dependencies as described in [monero documentation ](https://github.com/monero-project/monero ) into msys2 environment
2016-10-21 21:28:49 +00:00
**As we only build application for x86, install only dependencies for x86 architecture (i686 in package name)**
2017-03-04 04:17:23 +00:00
```
pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost
```
2016-10-21 21:28:49 +00:00
2017-05-15 02:44:48 +00:00
3. Install git into msys2 environment
2016-10-12 21:10:00 +00:00
```
pacman -S git
```
2017-05-15 02:44:48 +00:00
4. Install Qt5 from [official site ](https://www.qt.io/download-open-source/ )
2016-10-21 21:28:49 +00:00
- download unified installer, run and select following options:
- Qt > Qt 5.7 > MinGW 5.3.0 32 bit
- Tools > MinGW 5.3.0
- continue with installation
2016-10-12 21:10:00 +00:00
2017-05-15 02:44:48 +00:00
5. Open ```MinGW-w64 Win32 Shell``` shell
2016-10-13 12:35:57 +00:00
2016-10-21 21:28:49 +00:00
```%MSYS_ROOT%\msys2_shell.cmd -mingw32```
2016-11-09 07:55:31 +00:00
2016-10-13 12:35:57 +00:00
Where ```%MSYS_ROOT%``` will be ```c:\msys32``` if your host OS is x86-based or ```c:\msys64``` if your host OS
is x64-based
2016-10-21 21:28:49 +00:00
2017-05-15 02:44:48 +00:00
6. Install the latest version of boost, specificly the required static libraries
2017-03-04 04:17:23 +00:00
```
cd
wget http://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.tar.bz2
tar xjf boost_1_63_0.tar.bz2
cd boost_1_63_0
./bootstrap.sh mingw
./b2 --prefix=/mingw32/boost --layout=tagged --without-mpi --without-python toolset=gcc address-model=32 variant=debug,release link=static threading=multi runtime-link=static -j$(nproc) install
```
2017-05-15 02:44:48 +00:00
7. Clone repository
2016-10-13 12:35:57 +00:00
```
2017-03-04 04:17:23 +00:00
cd
2016-10-13 12:35:57 +00:00
git clone https://github.com/monero-project/monero-core.git
```
2017-05-15 02:44:48 +00:00
8. Build the GUI
2016-10-13 12:57:54 +00:00
```
cd monero-core
2017-03-04 04:17:23 +00:00
export PATH=$(ls -rd /c/Qt/5.[6,7,8]/mingw53_32/bin | head -1):$PATH
./build.sh
cd build
make deploy
2016-10-13 12:57:54 +00:00
```
2017-05-15 02:44:48 +00:00
The executable can be found in the ```.\release\bin``` directory.