Fixup README changes
- Revert moving of ports and branching strategy because those are actively preventing questions and PR difficulty - Remove travis badge because we no longer use travis - Fix formulation throughout the document - Rewrite the contribution section - Switch from Dogecoin devs twitter to Dogecoin twitter under communities - Add Q&A board to FAQ section - Fix document language selector - Bring tables back to "mining information"
This commit is contained in:
Patrick Lodder
parent
0d8e62471c
commit
73d8703534
20
INSTALL.md
20
INSTALL.md
|
|
@ -12,26 +12,6 @@ bug fixes are ready.
|
|||
- [Unix Build Notes](doc/build-unix.md)
|
||||
- [Windows Build Notes](doc/build-windows.md)
|
||||
|
||||
### Such ports
|
||||
|
||||
- RPC 22555
|
||||
- P2P 22556
|
||||
|
||||
#### Version strategy
|
||||
Version numbers are following ```major.minor.patch``` semantics.
|
||||
|
||||
#### Branches
|
||||
There are 3 types of branches in this repository:
|
||||
|
||||
- **master:** Stable, contains the latest version of the latest *major.minor* release.
|
||||
- **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.*
|
||||
|
||||
#### Contributions ✍️
|
||||
|
||||
Developers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and to
|
||||
|
|
|
|||
84
README.md
84
README.md
|
|
@ -7,55 +7,97 @@ Dogecoin Core [DOGE, Ð]
|
|||
<div align="center">
|
||||
|
||||
[](https://dogecoin.com)
|
||||
[](https://travis-ci.com/dogecoin/dogecoin)
|
||||
[](https://dogecoin.com)
|
||||
|
||||
</div>
|
||||
|
||||
Select Doc Language: ENG | [CN_simplified](./README_zh_CN.md) | [more...](./README.md)
|
||||
Select language: EN | [CN](./README_zh_CN.md)
|
||||
|
||||
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)
|
||||
|
||||
**Website:** [dogecoin.com](https://dogecoin.com)
|
||||
|
||||
## Ongoing development - Moon plan 🌒
|
||||
|
||||
Dogecoin Core is an open source and community driven software.
|
||||
Development process is done publicly. Anyone can see, discuss and work on them.
|
||||
Dogecoin Core is an open source and community driven software. The development
|
||||
process is open and publicly visible; anyone can see, discuss and work on the
|
||||
software.
|
||||
|
||||
Main tools used for the core development :
|
||||
Main development resources:
|
||||
|
||||
* [Github Projects](https://github.com/dogecoin/dogecoin/projects) to see all developments and [Github Discussion](https://github.com/dogecoin/dogecoin/discussions) to discuss them
|
||||
* [Dogecoin Improvement Proposals (DIPs)](https://github.com/dogecoin/dips) for major improvements
|
||||
* [Github Projects](https://github.com/dogecoin/dogecoin/projects) is used to
|
||||
follow planned and in-progress work for upcoming releases.
|
||||
* [Github Discussion](https://github.com/dogecoin/dogecoin/discussions) is used
|
||||
to discuss features, planned and unplanned, related to both the development of
|
||||
the Dogecoin Core software, the underlying protocols and the DOGE asset.
|
||||
* [Dogecoindev subreddit](https://www.reddit.com/r/dogecoindev/)
|
||||
|
||||
## Installation – omg developers 👨💻
|
||||
### Version strategy
|
||||
Version numbers are following ```major.minor.patch``` semantics.
|
||||
|
||||
To get all information to setup Dogecoin Core locally, see [INSTALL.md](INSTALL.md).
|
||||
### Branches
|
||||
There are 3 types of branches in this repository:
|
||||
|
||||
## Contribute 🤝
|
||||
- **master:** Stable, contains the latest version of the latest *major.minor* release.
|
||||
- **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```
|
||||
|
||||
Look at [CONTRIBUTING.md](CONTRIBUTING.md) to see how you can participate !
|
||||
*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.*
|
||||
|
||||
Do not limitate yourself to guidelines, feel free to contribute in your own way 🚀.
|
||||
## Installation 💻
|
||||
|
||||
## Community 🚀🍾
|
||||
Please see [the installation guide](INSTALL.md) for information about installing
|
||||
Dogecoin Core.
|
||||
|
||||
You can join the community on different social media !
|
||||
To see what's going on, meet people & discuss, find the lastest meme, learn about dogecoin,
|
||||
give or ask different type of help, to share your project... some places to visit !
|
||||
### Such ports
|
||||
|
||||
Dogecoin Core by default uses port `22556` for peer-to-peer communication that
|
||||
is needed to synchronize the "mainnet" blockchain and stay informed of new
|
||||
transactions and blocks. Additionally, a JSONRPC port can be opened, which
|
||||
defaults to port `22555` for mainnet nodes. It is strongly recommended to not
|
||||
expose RPC ports to the public internet.
|
||||
|
||||
| Function | mainnet | testnet | regtest |
|
||||
| :------- | ------: | ------: | ------: |
|
||||
| P2P | 22556 | 44556 | 18444 |
|
||||
| RPC | 22555 | 44555 | 18332 |
|
||||
|
||||
## Contributing 🤝
|
||||
|
||||
If you find a bug or experience issues with this software, please report it
|
||||
using the [issue system](https://github.com/dogecoin/dogecoin/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5Bbug%5D+).
|
||||
|
||||
Please see [the contribution guide](CONTRIBUTING.md) to see how you can
|
||||
participate in the development of Dogecoin Core. There are often
|
||||
[topics seeking help](https://github.com/dogecoin/dogecoin/labels/help%20wanted)
|
||||
where your contributions will have high impact and get very appreciation. wow.
|
||||
|
||||
## Communities 🚀🍾
|
||||
|
||||
You can join the communities on different social media.
|
||||
To see what's going on, meet people & discuss, find the lastest meme, learn
|
||||
about Dogecoin, give or ask for help, to share your project.
|
||||
|
||||
Here are some places to visit:
|
||||
|
||||
* [Discord](https://discord.gg/dogecoin)
|
||||
* [Dogecoin subreddit](https://www.reddit.com/r/dogecoin/)
|
||||
* [Dogeducation subreddit](https://www.reddit.com/r/dogeducation/)
|
||||
* [Dogecoin Devs Twitter](https://twitter.com/dogecoin_devs)
|
||||
* [Discord](https://discord.gg/dogecoin)
|
||||
* [Dogecoin Twitter](https://twitter.com/dogecoin)
|
||||
|
||||
## Very Much Frequently Asked Questions ❓
|
||||
|
||||
You have a question regarding dogecoin ? An answer is perhaps already in the [FAQ](doc/FAQ.md) !
|
||||
Do you have a question regarding Dogecoin? An answer is perhaps already in the
|
||||
[FAQ](doc/FAQ.md) or the
|
||||
[Q&A section](https://github.com/dogecoin/dogecoin/discussions/categories/q-a)
|
||||
of the discussion board!
|
||||
|
||||
## License – Much license ⚖️
|
||||
## 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)
|
||||
|
|
|
|||
36
doc/FAQ.md
36
doc/FAQ.md
|
|
@ -14,7 +14,7 @@ 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.
|
||||
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
|
||||
|
|
@ -29,18 +29,26 @@ 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
|
||||
| Block | Reward in Dogecoin |
|
||||
| :------------------- | -----------------: |
|
||||
| 1–99,999 | 0–1,000,000 |
|
||||
| 100,000–144,999 | 0–500,000 |
|
||||
| 145,000–199,999 | 250,000 |
|
||||
| 200,000–299,999 | 125,000 |
|
||||
| 300,000–399,999 | 62,500 |
|
||||
| 400,000–499,999 | 31,250 |
|
||||
| 500,000–599,999 | 15,625 |
|
||||
| 600,000+ | 10,000 |
|
||||
|
||||
100,000–144,999: 0–500,000 Dogecoin
|
||||
**The original block reward schedule, with one-minute block targets and
|
||||
four-hour difficulty readjustment:**
|
||||
|
||||
145,000–199,999: 250,000 Dogecoin
|
||||
|
||||
200,000–299,999: 125,000 Dogecoin
|
||||
|
||||
300,000–399,999: 62,500 Dogecoin
|
||||
|
||||
400,000–499,999: 31,250 Dogecoin
|
||||
|
||||
500,000–599,999: 15,625 Dogecoin
|
||||
|
||||
600,000+: 10,000 Dogecoin
|
||||
| Block | Reward in Dogecoin |
|
||||
| :------------------- | -----------------: |
|
||||
| 1–99,999 | 0–1,000,000 |
|
||||
| 100,000–199,999 | 0–500,000 |
|
||||
| 200,000–299,999 | 0–250,000 |
|
||||
| 300,000–399,999 | 0–125,000 |
|
||||
| 400,000–499,999 | 0–62,500 |
|
||||
| 500,000–599,999 | 0–31,250 |
|
||||
| 600,000+ | 10,000 |
|
||||
|
|
|
|||
Loading…
Reference in New Issue