forked from monero-project/monero-gui
-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from stoffu/aeon-readme
Minimal changes to README.md
- Loading branch information
Showing
1 changed file
with
34 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,44 @@ | ||
| # Aeon GUI | ||
|
|
||
| Copyright (c) 2014-2018, The Monero Project | ||
| Copyright (c) 2014-2018, AEON, The Monero Project | ||
|
|
||
| ## Development resources | ||
|
|
||
| - Web: [getmonero.org](https://getmonero.org) | ||
| - Forum: [forum.getmonero.org](https://forum.getmonero.org) | ||
| - Mail: [[email protected]](mailto:[email protected]) | ||
| - Github: [https://github.com/monero-project/monero-gui](https://github.com/monero-project/monero-gui) | ||
| - IRC: [#monero-dev on Freenode](irc://chat.freenode.net/#monero-dev) | ||
| - Web: [aeon.cash](http://aeon.cash) | ||
| - Bitcointalk: https://bitcointalk.org/index.php?topic=641696.0 | ||
| - Reddit: https://www.reddit.com/r/Aeon | ||
| - Github: [https://github.com/aeonix/aeon-gui](https://github.com/aeonix/aeon-gui) | ||
| - IRC: [#aeon on Freenode](irc://chat.freenode.net/#aeon) | ||
|
|
||
| ## Vulnerability response | ||
|
|
||
| - Vulnerability response should be redirected to Monero because much of Aeon's technical ground is shared | ||
| - Our [Vulnerability Response Process](https://github.com/monero-project/meta/blob/master/VULNERABILITY_RESPONSE_PROCESS.md) encourages responsible disclosure | ||
| - We are also available via [HackerOne](https://hackerone.com/monero) | ||
|
|
||
| ## Introduction | ||
|
|
||
| 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. | ||
| Aeon 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. | ||
|
|
||
| **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. | ||
| **Privacy:** Aeon 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. | ||
|
|
||
| **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. | ||
|
|
||
| **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. | ||
| **Untraceability:** By taking advantage of ring signatures, a special property of a certain type of cryptography, Aeon 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. | ||
|
|
||
| ## About this project | ||
|
|
||
| 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. | ||
| This is the GUI for the [core Aeon implementation](https://github.com/aeonix/aeon). 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 Aeon that uses the protocol and network in a compatible manner. | ||
|
|
||
| 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. | ||
|
|
||
| ## Supporting the project | ||
|
|
||
| Monero is a 100% community-sponsored endeavor. If you want to join our efforts, the easiest thing you can do is support the project financially. Both Monero and Bitcoin donations can be made to **donate.getmonero.org** if using a client that supports the [OpenAlias](https://openalias.org) standard. | ||
| Aeon is a 100% community-sponsored endeavor. If you want to join our efforts, the easiest thing you can do is support the project financially. Both Aeon and Bitcoin donations can be made to **donate.aeon.cash** if using a client that supports the [OpenAlias](https://openalias.org) standard. | ||
|
|
||
| The Monero donation address is: `44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A` (viewkey: `f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501`) | ||
| The Aeon donation address is: `WmsSWgtT1JPg5e3cK41hKXSHVpKW7e47bjgiKmWZkYrhSS5LhRemNyqayaSBtAQ6517eo5PtH9wxHVmM78JDZSUu2W8PqRiNs` (viewkey: `71bf19a7348ede17fa487167710dac401ef1556851bfd36b76040facf051630b`) | ||
|
|
||
| The Bitcoin donation address is: `1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H` | ||
| The Bitcoin donation address is: `12Cyjf3qV6qLyXdzpLSLPdRFPUVidvnzFM` | ||
|
|
||
| GUI development funding and/or some supporting services are also graciously provided by sponsors: | ||
|
|
||
|
|
@@ -49,29 +50,29 @@ GUI development funding and/or some supporting services are also graciously prov | |
| [<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/) | ||
|
|
||
| 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). | ||
| 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=641696.0). | ||
|
|
||
| ## License | ||
|
|
||
| See [LICENSE](LICENSE). | ||
|
|
||
| ## Installing the Monero GUI from a package | ||
| ## Installing the Aeon GUI from a package | ||
|
|
||
| Packages are available for | ||
| (**TODO**) ~Packages are available for~ | ||
|
|
||
| * Arch Linux via AUR: [monero-wallet-qt](https://aur.archlinux.org/packages/monero-wallet-qt/) | ||
| * Void Linux: xbps-install -S monero-core | ||
| * GuixSD: guix package -i monero-core | ||
| * ~Arch Linux via AUR: [aeon-wallet-qt](https://aur.archlinux.org/packages/aeon-wallet-qt/)~ | ||
| * ~Void Linux: xbps-install -S aeon-core~ | ||
| * ~GuixSD: guix package -i aeon-core~ | ||
|
|
||
| Packaging for your favorite distribution would be a welcome contribution! | ||
|
|
||
| ## Compiling the Monero GUI from source | ||
| ## Compiling the Aeon GUI from source | ||
|
|
||
| ### On Linux: | ||
|
|
||
| (Tested on Ubuntu 16.04 x86, 16.10 x64, Gentoo x64 and Linux Mint 18 "Sarah" - Cinnamon x64) | ||
|
|
||
| 1. Install Monero dependencies | ||
| 1. Install Aeon dependencies | ||
|
|
||
| - For Ubuntu and Mint | ||
|
|
||
|
|
@@ -81,13 +82,13 @@ Packaging for your favorite distribution would be a welcome contribution! | |
|
|
||
| `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 net-libs/zeromq sys-libs/libunwind` | ||
|
|
||
| 2. Grab an up-to-date copy of the monero-gui repository | ||
| 2. Grab an up-to-date copy of the aeon-gui repository | ||
|
|
||
| `git clone https://github.com/monero-project/monero-gui.git` | ||
| `git clone https://github.com/aeonix/aeon-gui.git` | ||
|
|
||
| 3. Go into the repository | ||
|
|
||
| `cd monero-gui` | ||
| `cd aeon-gui` | ||
|
|
||
| 4. Install the GUI dependencies | ||
|
|
||
|
|
@@ -137,7 +138,7 @@ The executable can be found in the build/release/bin folder. | |
|
|
||
| 2. Install [homebrew](http://brew.sh/) | ||
|
|
||
| 3. Install [monero](https://github.com/monero-project/monero) dependencies: | ||
| 3. Install [Aeon](https://github.com/aeonix/aeon) dependencies: | ||
|
|
||
| `brew install boost --c++11` | ||
|
|
||
|
|
@@ -165,13 +166,13 @@ The executable can be found in the build/release/bin folder. | |
|
|
||
| This is the directory where Qt 5.x is installed on **your** system | ||
|
|
||
| 6. Grab an up-to-date copy of the monero-gui repository | ||
| 6. Grab an up-to-date copy of the aeon-gui repository | ||
|
|
||
| `git clone https://github.com/monero-project/monero-gui.git` | ||
| `git clone https://github.com/aeonix/aeon-gui.git` | ||
|
|
||
| 7. Go into the repository | ||
|
|
||
| `cd monero-gui` | ||
| `cd aeon-gui` | ||
|
|
||
| 8. Start the build | ||
|
|
||
|
|
@@ -194,19 +195,19 @@ More info: http://stackoverflow.com/a/35098040/1683164 | |
|
|
||
| ### On Windows: | ||
|
|
||
| The Monero GUI on Windows is 64 bits only; 32-bit Windows GUI builds are not officially supported anymore. | ||
| The Aeon GUI on Windows is 64 bits only; 32-bit Windows GUI builds are not officially supported anymore. | ||
|
|
||
| 1. Install [MSYS2](https://www.msys2.org/), follow the instructions on that page on how to update system and packages to the latest versions | ||
|
|
||
| 2. Open an 64-bit MSYS2 shell: Use the *MSYS2 MinGW 64-bit* shortcut, or use the `msys2_shell.cmd` batch file with a `-mingw64` parameter | ||
|
|
||
| 3. Install MSYS2 packages for Monero dependencies; the needed 64-bit packages have `x86_64` in their names | ||
| 3. Install MSYS2 packages for Aeon dependencies; the needed 64-bit packages have `x86_64` in their names | ||
|
|
||
| ``` | ||
| pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium | ||
| ``` | ||
|
|
||
| You find more details about those dependencies in the [Monero documentation](https://github.com/monero-project/monero). Note that that there is no more need to compile Boost from source; like everything else, you can install it now with a MSYS2 package. | ||
| You find more details about those dependencies in the [Aeon documentation](https://github.com/aeonix/aeon). Note that that there is no more need to compile Boost from source; like everything else, you can install it now with a MSYS2 package. | ||
|
|
||
| 4. Install Qt5 | ||
|
|
||
|
|
@@ -225,13 +226,13 @@ The Monero GUI on Windows is 64 bits only; 32-bit Windows GUI builds are not off | |
| 6. Clone repository | ||
|
|
||
| ``` | ||
| git clone https://github.com/monero-project/monero-gui.git | ||
| git clone https://github.com/aeonix/aeon-gui.git | ||
| ``` | ||
|
|
||
| 7. Build | ||
|
|
||
| ``` | ||
| cd monero-gui | ||
| cd aeon-gui | ||
| ./build.sh | ||
| cd build | ||
| make deploy | ||
|
|
||