diff --git a/README.md b/README.md index 3632a933b409e..f70f10e4db190 100644 --- a/README.md +++ b/README.md @@ -1,80 +1 @@ -Dash Core staging tree 0.17 -=========================== - -|CI|master|develop| -|-|-|-| -|Gitlab|[![Build Status](https://gitlab.com/dashpay/dash/badges/master/pipeline.svg)](https://gitlab.com/dashpay/dash/-/tree/master)|[![Build Status](https://gitlab.com/dashpay/dash/badges/develop/pipeline.svg)](https://gitlab.com/dashpay/dash/-/tree/develop)| - -https://www.dash.org - - -What is Dash? -------------- - -Dash is an experimental digital currency that enables instant, private -payments to anyone, anywhere in the world. Dash uses peer-to-peer technology -to operate with no central authority: managing transactions and issuing money -are carried out collectively by the network. Dash Core is the name of the open -source software which enables the use of this currency. - -For more information, as well as an immediately useable, binary version of -the Dash Core software, see https://www.dash.org/get-dash/. - - -License -------- - -Dash Core is released under the terms of the MIT license. See [COPYING](COPYING) for more -information or see https://opensource.org/licenses/MIT. - -Development Process -------------------- - -The `master` branch is meant to be stable. Development is normally done in separate branches. -[Tags](https://github.com/dashpay/dash/tags) are created to indicate new official, -stable release versions of Dash Core. - -The contribution workflow is described in [CONTRIBUTING.md](CONTRIBUTING.md) -and useful hints for developers can be found in [doc/developer-notes.md](doc/developer-notes.md). - -Testing -------- - -Testing and code review is the bottleneck for development; we get more pull -requests than we can review and test on short notice. Please be patient and help out by testing -other people's pull requests, and remember this is a security-critical project where any mistake might cost people -lots of money. - -### Automated Testing - -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 -(assuming they weren't disabled in configure) with: `make check`. Further details on running -and extending unit tests can be found in [/src/test/README.md](/src/test/README.md). - -There are also [regression and integration tests](/test), written -in Python, that are run automatically on the build server. -These tests can be run (if the [test dependencies](/test) are installed) with: `test/functional/test_runner.py` - -The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically. - -### Manual Quality Assurance (QA) Testing - -Changes should be tested by somebody other than the developer who wrote the -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. - -Translations ------------- - -Changes to translations as well as new translations can be submitted to -[Dash Core's Transifex page](https://www.transifex.com/projects/p/dash/). - -Translations are periodically pulled from Transifex and merged into the git repository. See the -[translation process](doc/translation_process.md) for details on how this works. - -**Important**: We do not accept translation changes as GitHub pull requests because the next -pull from Transifex would automatically overwrite them again. - -Translators should also follow the [forum](https://www.dash.org/forum/topic/dash-worldwide-collaboration.88/). +A