diff --git a/README.md b/README.md index 312e2d00ec..a1a27e6e00 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,36 @@ -Bitcoin Core integration/staging tree +Litecoin Core integration/staging tree ===================================== -https://bitcoincore.org +[![Build Status](https://travis-ci.org/litecoin-project/litecoin.svg?branch=master)](https://travis-ci.org/litecoin-project/litecoin) -What is Bitcoin? +https://litecoin.org + +What is Litecoin? ---------------- -Bitcoin is an experimental digital currency that enables instant payments to -anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate +Litecoin is an experimental digital currency that enables instant payments to +anyone, anywhere in the world. Litecoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried -out collectively by the network. Bitcoin Core is the name of open source +out collectively by the network. Litecoin Core is the name of open source software which enables the use of this currency. -For more information, as well as an immediately usable, binary version of -the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the -[original whitepaper](https://bitcoincore.org/bitcoin.pdf). +For more information, as well as an immediately useable, binary version of +the Litecoin Core software, see [https://litecoin.org](https://litecoin.org). License ------- -Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more +Litecoin 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 regularly built (see `doc/build-*.md` for instructions) and tested, but it is not guaranteed to be -completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created -regularly from release branches to indicate new official, stable release versions of Bitcoin Core. +completely stable. [Tags](https://github.com/litecoin-project/litecoin/tags) are created +regularly from release branches to indicate new official, stable release versions of Litecoin Core. -The https://github.com/bitcoin-core/gui repository is used exclusively for the +The https://github.com/litecoin-project/gui repository is used exclusively for the development of the GUI. Its master branch is identical in all monotree repositories. Release branches and tags do not exist, so please do not fork that repository unless it is for development reasons. @@ -37,6 +38,12 @@ that 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 working +on a patch set. + +Developer IRC can be found on Freenode at #litecoin-dev. + Testing ------- @@ -68,13 +75,11 @@ not straightforward. Translations ------------ -Changes to translations as well as new translations can be submitted to -[Bitcoin Core's Transifex page](https://www.transifex.com/bitcoin/bitcoin/). +We only accept translation fixes that are submitted through [Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/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 next pull from Transifex would automatically overwrite them again. - -Translators should also subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).