mirror of
https://github.com/monero-project/monero-gui
synced 2024-12-25 01:53:43 +01:00
Merge pull request #40
44ca99b
minor renames in the readme (Riccardo Spagni)d6c7f34
readme fixes (Riccardo Spagni)
This commit is contained in:
commit
fab66fec38
39
README.md
39
README.md
@ -1,33 +1,30 @@
|
|||||||
# Monero Core
|
# Monero Core
|
||||||
|
|
||||||
Copyright (c) 2014-2015, The Monero Project
|
Copyright (c) 2014-2016, The Monero Project
|
||||||
|
|
||||||
## Development Resources
|
## Development Resources
|
||||||
|
|
||||||
Web: [getmonero.org](https://getmonero.org)
|
- Web: [getmonero.org](https://getmonero.org)
|
||||||
Forum: [forum.getmonero.org](https://forum.getmonero.org)
|
- Forum: [forum.getmonero.org](https://forum.getmonero.org)
|
||||||
Mail: [dev@getmonero.org](mailto:dev@getmonero.org)
|
- Mail: [dev@getmonero.org](mailto:dev@getmonero.org)
|
||||||
Github (staging): [https://github.com/monero-project/bitmonero](https://github.com/monero-project/bitmonero)
|
- Github: [https://github.com/monero-project/monero-core](https://github.com/monero-project/monero-core)
|
||||||
Github (development): [http://github.com/monero-project/bitmonero/tree/development](http://github.com/monero-project/bitmonero/tree/development)
|
- IRC: [#monero-dev on Freenode](irc://chat.freenode.net/#monero-dev)
|
||||||
IRC: [#monero-dev on Freenode](irc://chat.freenode.net/#monero-dev)
|
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Monero is a private, secure, untraceable currency. You are your bank, you control your funds, and nobody can trace your transfers.
|
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.
|
||||||
|
|
||||||
**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:** 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.
|
||||||
|
|
||||||
**Security:** Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 24 word mnemonic 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.
|
**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 certain types 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, 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.
|
||||||
|
|
||||||
## About this Project
|
## About this Project
|
||||||
|
|
||||||
This is the core GUI implementation of 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 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.
|
||||||
|
|
||||||
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, merged to the staging repo, and then subsequently tested by contributors who focus on thorough 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.
|
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.
|
||||||
|
|
||||||
Anyone is able to contribute to Monero. If you have a fix or code change, feel free to submit is as a pull request directly to the "development" branch. In cases where the change is relatively small or does not affect other parts of the codebase it may be merged in immediately by any one of the collaborators. On the other hand, if the change is particularly large or complex, it is expected that it will be discussed at length either well in advance of the pull request being submitted, or even directly on the pull request.
|
|
||||||
|
|
||||||
## Supporting the Project
|
## Supporting the Project
|
||||||
|
|
||||||
@ -35,9 +32,9 @@ 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
|
Both Monero and Bitcoin donations can be made to donate.getmonero.org if using a client that supports the [OpenAlias](https://openalias.org) standard
|
||||||
|
|
||||||
The Monero donation address is: 46BeWrHpwXmHDpDEUmZBWZfoQpdc6HaERCNmx1pEYL2rAcuwufPN9rXHHtyUA4QVy66qeFQkn6sfK8aHYjA3jk3o1Bv16em (viewkey: e422831985c9205238ef84daf6805526c14d96fd7b059fe68c7ab98e495e5703)
|
The Monero donation address is: `44AFFq5kSiGBoZ4NMDwYtN18obc8AemS33DBLWs3H7otXft3XjrpDtQGv7SqSsaBYBb98uNbr2VBBEt7f2wfn3RVGQBEP3A` (viewkey: `f359631075708155cc3d92a32b75a7d02a5dcf27756707b47a2b31b21c389501`)
|
||||||
|
|
||||||
The Bitcoin donation address is: 1FhnVJi2V1k4MqXm2nHoEbY5LV7FPai7bb
|
The Bitcoin donation address is: `1KTexdemPdxSBcG55heUuTjDRYqbC5ZL8H`
|
||||||
|
|
||||||
Core development funding and/or some supporting services are also graciously provided by sponsors:
|
Core development funding and/or some supporting services are also graciously provided by sponsors:
|
||||||
|
|
||||||
@ -46,6 +43,8 @@ Core development funding and/or some supporting services are also graciously pro
|
|||||||
[<img width="100" src="https://static.getmonero.org/images/sponsors/dome9.png"/>](http://dome9.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/araxis.png"/>](http://araxis.com)
|
||||||
[<img width="150" src="https://static.getmonero.org/images/sponsors/jetbrains.png"/>](http://www.jetbrains.com/)
|
[<img width="150" src="https://static.getmonero.org/images/sponsors/jetbrains.png"/>](http://www.jetbrains.com/)
|
||||||
|
[<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=583449.0).
|
||||||
|
|
||||||
@ -53,7 +52,7 @@ There are also several mining pools that kindly donate a portion of their fees,
|
|||||||
|
|
||||||
See [LICENSE](LICENSE).
|
See [LICENSE](LICENSE).
|
||||||
|
|
||||||
## Installing Monero-core from a Package
|
## Installing Monero Core from a Package
|
||||||
|
|
||||||
Packages are available for
|
Packages are available for
|
||||||
|
|
||||||
@ -61,7 +60,7 @@ Packages are available for
|
|||||||
|
|
||||||
Packaging for your favorite distribution would be a welcome contribution!
|
Packaging for your favorite distribution would be a welcome contribution!
|
||||||
|
|
||||||
## Compiling Monero-core from Source
|
## Compiling Monero Core from Source
|
||||||
|
|
||||||
### Dependencies
|
### Dependencies
|
||||||
|
|
||||||
@ -77,7 +76,7 @@ TODO
|
|||||||
|
|
||||||
2. Go to the repository where the most recent version is.
|
2. Go to the repository where the most recent version is.
|
||||||
|
|
||||||
`git clone https://github.com/mbg033/monero-core.git`
|
`git clone https://github.com/monero-project/monero-core.git`
|
||||||
|
|
||||||
3. Go into the repository.
|
3. Go into the repository.
|
||||||
|
|
||||||
@ -116,6 +115,7 @@ TODO
|
|||||||
`./release/bin/monero-core`
|
`./release/bin/monero-core`
|
||||||
|
|
||||||
### On OS X:
|
### On OS X:
|
||||||
|
|
||||||
1. install Xcode from AppStore
|
1. install Xcode from AppStore
|
||||||
2. install [homebrew] (http://brew.sh/)
|
2. install [homebrew] (http://brew.sh/)
|
||||||
3. install [bitmonero] (https://github.com/monero-project/bitmonero) dependencies:
|
3. install [bitmonero] (https://github.com/monero-project/bitmonero) dependencies:
|
||||||
@ -143,4 +143,5 @@ TODO
|
|||||||
```
|
```
|
||||||
|
|
||||||
### On Windows:
|
### On Windows:
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
Loading…
Reference in New Issue
Block a user