git / moonbite-core / README.md · raw
Litecoin Core integration/staging tree=====================================[](https://travis-ci.org/litecoin-project/litecoin)https://litecoin.orgWhat is Litecoin?----------------Litecoin is an experimental digital currency that enables instant payments toanyone, anywhere in the world. Litecoin uses peer-to-peer technology to operatewith no central authority: managing transactions and issuing money are carriedout collectively by the network. Litecoin Core is the name of open sourcesoftware which enables the use of this currency.For more information, as well as an immediately useable, binary version ofthe Litecoin Core software, see [https://litecoin.org](https://litecoin.org).License-------Litecoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for moreinformation or see https://opensource.org/licenses/MIT.Development Process-------------------The `master` branch is regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to becompletely stable. [Tags](https://github.com/litecoin-project/litecoin/tags) are createdregularly from release branches to indicate new official, stable release versions of Litecoin Core.The https://github.com/litecoin-project/gui repository is used exclusively for thedevelopment of the GUI. Its master branch is identical in all monotreerepositories. Release branches and tags do not exist, so please do not forkthat repository unless it is for development reasons.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).The developer [mailing list](https://groups.google.com/forum/#!forum/litecoin-dev)should be used to discuss complicated or controversial changes before workingon a patch set.Developer IRC can be found on Freenode at #litecoin-dev.Testing-------Testing and code review is the bottleneck for development; we get more pullrequests than we can review and test on short notice. Please be patient and help out by testingother people's pull requests, and remember this is a security-critical project where any mistake might cost peoplelots of money.### Automated TestingDevelopers are strongly encouraged to write [unit tests](src/test/README.md) for new code, and tosubmit 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 runningand extending unit tests can be found in [/src/test/README.md](/src/test/README.md).There are also [regression and integration tests](/test), writtenin 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) TestingChanges should be tested by somebody other than the developer who wrote thecode. This is especially important for large or high-risk changes. It is usefulto add a test plan to the pull request description if testing the changes isnot straightforward.Translations------------We only accept translation fixes that are submitted through [Bitcoin Core's Transifex page](https://explore.transifex.com/bitcoin/bitcoin/).Translations are converted to Litecoin periodically.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 nextpull from Transifex would automatically overwrite them again.