maxmustermann/dogecoin
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improve README.md

Browse source 
- Removed dead image links.
- Updated Travis ci badge link to direct to the master branch and the new Travis website url.
- Added Emojis to headers for clarity and to get the feel of dogecoin for newcomers.
- Bolded some sub headers for clarity. e.g. block reward sections.
- Code formatting.

  plodder: cherry pick notes:
  - Cherry-picked and sanitized to resolve conflicts
  - fixed some very long lines
  - removed tip4commit
  - changed header for mining/subsidy info
This commit is contained in:
fluteds 2021-02-28 12:25:35 +01:00 committed by Patrick Lodder
parent 4229222073
commit acb11bf065
No known key found for this signature in database
GPG key ID: 2D3A345B98D0DC1F
1 changed files with 46 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -1,21 +1,23 @@
# Dogecoin Core [DOGE, Ð]
==========================
![Dogecoin](https://static.tumblr.com/ppdj5y9/Ae9mxmxtp/300coin.png)
[![Build Status](https://travis-ci.org/dogecoin/dogecoin.svg?branch=1.14-dev)](https://travis-ci.org/dogecoin/dogecoin) [![tip for next commit](https://tip4commit.com/projects/702.svg)](https://tip4commit.com/github/dogecoin/dogecoin)
[![Build Status](https://travis-ci.org/dogecoin/dogecoin.svg?branch=master)](https://travis-ci.org/dogecoin/dogecoin)
## What is Dogecoin? – Such coin
Dogecoin is a cryptocurrency like Bitcoin, although it does not use SHA256 as its proof of work (POW). Taking development cues from Tenebrix and Litecoin, Dogecoin currently employs a simplified variant of scrypt.
Dogecoin is a cryptocurrency like Bitcoin, although it does not use SHA256 as
its proof of work (POW). Taking development cues from Tenebrix and Litecoin,
Dogecoin currently employs a simplified variant of scrypt.
- **Website:** [dogecoin.com.](https://dogecoin.com)
https://dogecoin.com/
## License – Much license
Dogecoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more
information or see https://opensource.org/licenses/MIT.
## License – Much license ⚖️
Dogecoin Core is released under the terms of the MIT license. See
[COPYING](COPYING) for more information or see
[opensource.org](https://opensource.org/licenses/MIT)
## Development and contributions – omg developers
Development is ongoing, and the development team, as well as other volunteers, can freely work in their own trees and submit pull requests when features or bug fixes are ready.
Development is ongoing, and the development team, as well as other volunteers,
can freely work in their own trees and submit pull requests when features or
bug fixes are ready.
#### Version strategy
Version numbers are following ```major.minor.patch``` semantics.
@ -27,9 +29,12 @@ There are 3 types of branches in this repository:
- **maintenance:** Stable, contains the latest version of previous releases, which are still under active maintenance. Format: ```<version>-maint```
- **development:** Unstable, contains new code for planned releases. Format: ```<version>-dev```
*Master and maintenance branches are exclusively mutable by release. Planned releases will always have a development branch and pull requests should be submitted against those. Maintenance branches are there for* ***bug fixes only,*** *please submit new features against the development branch with the highest version.*
*Master and maintenance branches are exclusively mutable by release. Planned*
*releases will always have a development branch and pull requests should be*
*submitted against those. Maintenance branches are there for **bug fixes only,***
*please submit new features against the development branch with the highest version.*
#### Contributions
#### Contributions ✍️
Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
submit new unit tests for old code. Unit tests can be compiled and run
@ -45,18 +50,36 @@ code. This is especially important for large or high-risk changes. It is useful
to add a test plan to the pull request description if testing the changes is
not straightforward.
## Very Much Frequently Asked Questions
## Very Much Frequently Asked Questions ❓
### How much doge can exist? – So many puppies!
Early 2015 (approximately a year and a half after release) there will be approximately 100,000,000,000 coins.
Each subsequent block will grant 10,000 coins to encourage miners to continue to secure the network and make up for lost wallets on hard drives/phones/lost encryption passwords/etc.
### How much doge can exist? – So many puppies! 🐕
Early 2015 (approximately a year and a half after release) there will be
approximately 100,000,000,000 coins.
Each subsequent block will grant 10,000 coins to encourage miners to continue to
secure the network and make up for lost wallets on hard drives/phones/lost
encryption passwords/etc.
### How to get doge? – To the moon!
Dogecoin uses a simplified variant of the scrypt key derivation function as its proof of work with a target time of one minute per block and difficulty readjustment after every block. The block rewards are fixed and halve every 100,000 blocks. Starting with the 600,000th block, a permanent reward of 10,000 Dogecoin per block will be issued.
Originally, a different payout scheme was envisioned with block rewards being determined by taking the maximum reward as per the block schedule and applying the result of a Mersenne Twister pseudo-random number generator to arrive at a number between 0 and the maximum reward. This was changed starting with block 145,000, to prevent large pools from gaming the system and mining only high reward blocks. At the same time, the difficulty retargeting was also changed from four hours to once per block (every minute), implementing an algorithm courtesy of the DigiByte Coin development team, to lessen the impact of sudden increases and decreases of network hashing rate.
### Such mining information ⛏
The current block reward schedule:
Dogecoin uses a simplified variant of the scrypt key derivation function as its
proof of work with a target time of one minute per block and difficulty
readjustment after every block. The block rewards are fixed and halve every
100,000 blocks. Starting with the 600,000th block, a permanent reward of
10,000 Dogecoin per block will be issued.
Originally, a different payout scheme was envisioned with block rewards being
determined by taking the maximum reward as per the block schedule and applying
the result of a Mersenne Twister pseudo-random number generator to arrive at a
number between 0 and the maximum reward.
This was changed starting with block 145,000, to prevent large pools from gaming
the system and mining only high reward blocks. At the same time, the difficulty
retargeting was also changed from four hours to once per block (every minute),
implementing an algorithm courtesy of the DigiByte Coin development team, to
lessen the impact of sudden increases and decreases of network hashing rate.
**The current block reward schedule:**
1–99,999: 0–1,000,000 Dogecoin
@ -74,7 +97,7 @@ The current block reward schedule:
600,000+: 10,000 Dogecoin
The original block reward schedule, with one-minute block targets and four-hour difficulty readjustment:
**The original block reward schedule, with one-minute block targets and four-hour difficulty readjustment:**
1–99,999: 0–1,000,000 Dogecoin
@ -99,10 +122,9 @@ The original block reward schedule, with one-minute block targets and four-hour
- [Windows Build Notes](doc/build-windows.md)
### Such ports
RPC 22555
P2P 22556
![](https://dogesay.com/3f5a00acf72df93528b6bb7cd0a4fd0c.jpeg)
- RPC 22555
- P2P 22556
## Development tips and tricks