maxmustermann
/
dogecoin
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
dogecoin/README.md

106 lines
4.8 KiB
Markdown
Raw Permalink Normal View History

Updated README Made the README much wow. Centered the title, logo, and badges. Added two badges that redirect to the website: "dogecoin" and "much wow" and removed the period that was included in the website's hyperlink.
2021-05-24 22:09:47 +02:00
<h1 align="center">
Dogecoin Core [DOGE, Ð]
<br/><br/>
<img src="https://static.tumblr.com/ppdj5y9/Ae9mxmxtp/300coin.png" alt="Dogecoin" width="300"/>
</h1>
update and reformat README.md * updated references to files which have since been moved * added reference to licensing * added brief summary in case a non-technical user happens upon repo first * miscellaneous Markdown-isms to make the doc more attractive * remove unused symlink README -> README.md I double-checked the makefiles and whatnot to ensure that the README symlink is not being referenced. It is not. Rather, `doc/README` and `doc/README_windows.txt` are copied for distribution.
2012-12-13 03:27:58 +01:00
Updated README Made the README much wow. Centered the title, logo, and badges. Added two badges that redirect to the website: "dogecoin" and "much wow" and removed the period that was included in the website's hyperlink.
2021-05-24 22:09:47 +02:00
<div align="center">
Add travis build:passing/failing indicator.
2014-08-26 11:10:52 +02:00
Updated README Made the README much wow. Centered the title, logo, and badges. Added two badges that redirect to the website: "dogecoin" and "much wow" and removed the period that was included in the website's hyperlink.
2021-05-24 22:09:47 +02:00
[![DogecoinBadge](https://img.shields.io/badge/Doge-Coin-yellow.svg)](https://dogecoin.com)
[![MuchWow](https://img.shields.io/badge/Much-Wow-yellow.svg)](https://dogecoin.com)
</div>
update and reformat README.md * updated references to files which have since been moved * added reference to licensing * added brief summary in case a non-technical user happens upon repo first * miscellaneous Markdown-isms to make the doc more attractive * remove unused symlink README -> README.md I double-checked the makefiles and whatnot to ensure that the README symlink is not being referenced. It is not. Rather, `doc/README` and `doc/README_windows.txt` are copied for distribution.
2012-12-13 03:27:58 +01:00
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"
2021-08-20 02:16:13 +02:00
Select language: EN | [CN](./README_zh_CN.md)
Add simplified Chinese for the main README doc
2021-05-26 11:35:32 +02:00
Docs4Doge: refresh README introduction sentence
2021-09-14 18:24:28 +02:00
Dogecoin is a community-driven cryptocurrency that was inspired by a Shiba Inu meme. The Dogecoin Core software allows anyone to operate a node in the Dogecoin blockchain networks and uses the Scrypt hashing method for Proof of Work. It is adapted from Bitcoin Core and other cryptocurrencies.
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"
2021-08-20 02:16:13 +02:00
doc: add link to fee recommendation
2021-11-04 22:09:18 +01:00
For information about the default fees used on the Dogecoin network, please
refer to the [fee recommendation](doc/fee-recommendation.md).
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"
2021-08-20 02:16:13 +02:00
**Website:** [dogecoin.com](https://dogecoin.com)
update and reformat README.md * updated references to files which have since been moved * added reference to licensing * added brief summary in case a non-technical user happens upon repo first * miscellaneous Markdown-isms to make the doc more attractive * remove unused symlink README -> README.md I double-checked the makefiles and whatnot to ensure that the README symlink is not being referenced. It is not. Rather, `doc/README` and `doc/README_windows.txt` are copied for distribution.
2012-12-13 03:27:58 +01:00
Docs4doge: add getting started section
2021-11-04 22:24:32 +01:00
## Usage 💻
readme: move development under installation
2021-08-20 02:26:11 +02:00
Docs4doge: add getting started section
2021-11-04 22:24:32 +01:00
To start your journey with Dogecoin Core, see the [installation guide](INSTALL.md) and the [getting started](doc/getting-started.md) tutorial.
The JSON-RPC API provided by Dogecoin Core is self-documenting and can be browsed with `dogecoin-cli help`, while detailed information for each command can be viewed with `dogecoin-cli help <command>`. Alternatively, see the [Bitcoin Core documentation](https://developer.bitcoin.org/reference/rpc/) - which implement a similar protocol - to get a browsable version.
readme: move development under installation
2021-08-20 02:26:11 +02:00
### 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 |
Update README.md Author: AbcSxyZ <rossi.sim@outlook.com> Cherry-picked and squashed from: 20480d33b README: change social media position 39a209b98 README: Change section order bdb727981 README: reorganize social medias, split dev specific & and more community related in 2 sections bbc6c921c Add emote to titles e39256825 Install.md : Improve first title ebef882c5 Fix typo 1cec6b16b Extract FAQ and INSTALL into respective files 314b6f8e2 Add developement & contribution information directly on readme a7e556924 Remove original block reward schedule 8cb73041a Move licence section at README bottom
2021-05-26 18:21:03 +02:00
## Ongoing development - Moon plan 🌒
Improve README.md - 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
2021-02-28 12:25:35 +01:00
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"
2021-08-20 02:16:13 +02:00
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.
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
Main development resources:
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
* [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.
Update README.md Author: AbcSxyZ <rossi.sim@outlook.com> Cherry-picked and squashed from: 20480d33b README: change social media position 39a209b98 README: Change section order bdb727981 README: reorganize social medias, split dev specific & and more community related in 2 sections bbc6c921c Add emote to titles e39256825 Install.md : Improve first title ebef882c5 Fix typo 1cec6b16b Extract FAQ and INSTALL into respective files 314b6f8e2 Add developement & contribution information directly on readme a7e556924 Remove original block reward schedule 8cb73041a Move licence section at README bottom
2021-05-26 18:21:03 +02:00
* [Dogecoindev subreddit](https://www.reddit.com/r/dogecoindev/)
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
### Version strategy
Version numbers are following ```major.minor.patch``` semantics.
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
### Branches
There are 3 types of branches in this repository:
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
- **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```
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
*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.*
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
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"
2021-08-20 02:16:13 +02:00
## 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:
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
Update README.md Author: AbcSxyZ <rossi.sim@outlook.com> Cherry-picked and squashed from: 20480d33b README: change social media position 39a209b98 README: Change section order bdb727981 README: reorganize social medias, split dev specific & and more community related in 2 sections bbc6c921c Add emote to titles e39256825 Install.md : Improve first title ebef882c5 Fix typo 1cec6b16b Extract FAQ and INSTALL into respective files 314b6f8e2 Add developement & contribution information directly on readme a7e556924 Remove original block reward schedule 8cb73041a Move licence section at README bottom
2021-05-26 18:21:03 +02:00
* [Dogecoin subreddit](https://www.reddit.com/r/dogecoin/)
* [Dogeducation subreddit](https://www.reddit.com/r/dogeducation/)
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"
2021-08-20 02:16:13 +02:00
* [Discord](https://discord.gg/dogecoin)
* [Dogecoin Twitter](https://twitter.com/dogecoin)
Update documentation to match 1.10 (#1436)
2018-01-20 19:35:31 +01:00
Update README.md Author: AbcSxyZ <rossi.sim@outlook.com> Cherry-picked and squashed from: 20480d33b README: change social media position 39a209b98 README: Change section order bdb727981 README: reorganize social medias, split dev specific & and more community related in 2 sections bbc6c921c Add emote to titles e39256825 Install.md : Improve first title ebef882c5 Fix typo 1cec6b16b Extract FAQ and INSTALL into respective files 314b6f8e2 Add developement & contribution information directly on readme a7e556924 Remove original block reward schedule 8cb73041a Move licence section at README bottom
2021-05-26 18:21:03 +02:00
## Very Much Frequently Asked Questions ❓
doc: add note about translations to README.md
2014-04-09 20:11:08 +02:00
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"
2021-08-20 02:16:13 +02:00
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!
Add Tips and Tricks section to README
2014-05-23 16:30:38 +02:00
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"
2021-08-20 02:16:13 +02:00
## License - Much license ⚖️
Update README.md Author: AbcSxyZ <rossi.sim@outlook.com> Cherry-picked and squashed from: 20480d33b README: change social media position 39a209b98 README: Change section order bdb727981 README: reorganize social medias, split dev specific & and more community related in 2 sections bbc6c921c Add emote to titles e39256825 Install.md : Improve first title ebef882c5 Fix typo 1cec6b16b Extract FAQ and INSTALL into respective files 314b6f8e2 Add developement & contribution information directly on readme a7e556924 Remove original block reward schedule 8cb73041a Move licence section at README bottom
2021-05-26 18:21:03 +02:00
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)