|
| 1 | +Litecoin integration/staging tree |
| 2 | +================================ |
| 3 | + |
| 4 | +http://www.litecoin.org |
| 5 | + |
| 6 | +Copyright (c) 2009-2014 Bitcoin Developers |
| 7 | +Copyright (c) 2011-2014 Litecoin Developers |
| 8 | + |
| 9 | +What is Litecoin? |
| 10 | +---------------- |
| 11 | + |
| 12 | +Litecoin is a lite version of Bitcoin using scrypt as a proof-of-work algorithm. |
| 13 | + - 2.5 minute block targets |
| 14 | + - subsidy halves in 840k blocks (~4 years) |
| 15 | + - ~84 million total coins |
| 16 | + |
| 17 | +The rest is the same as Bitcoin. |
| 18 | + - 50 coins per block |
| 19 | + - 2016 blocks to retarget difficulty |
| 20 | + |
| 21 | +For more information, as well as an immediately useable, binary version of |
| 22 | +the Litecoin client sofware, see http://www.litecoin.org. |
| 23 | + |
| 24 | +License |
| 25 | +------- |
| 26 | + |
| 27 | +Litecoin is released under the terms of the MIT license. See `COPYING` for more |
| 28 | +information or see http://opensource.org/licenses/MIT. |
| 29 | + |
| 30 | +Development process |
| 31 | +------------------- |
| 32 | + |
| 33 | +Developers work in their own trees, then submit pull requests when they think |
| 34 | +their feature or bug fix is ready. |
| 35 | + |
| 36 | +If it is a simple/trivial/non-controversial change, then one of the Litecoin |
| 37 | +development team members simply pulls it. |
| 38 | + |
| 39 | +If it is a *more complicated or potentially controversial* change, then the patch |
| 40 | +submitter will be asked to start a discussion (if they haven't already) on the |
| 41 | +[mailing list](http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development). |
| 42 | + |
| 43 | +The patch will be accepted if there is broad consensus that it is a good thing. |
| 44 | +Developers should expect to rework and resubmit patches if the code doesn't |
| 45 | +match the project's coding conventions (see `doc/coding.txt`) or are |
| 46 | +controversial. |
| 47 | + |
| 48 | +The `master` branch is regularly built and tested, but is not guaranteed to be |
| 49 | +completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created |
| 50 | +regularly to indicate new official, stable release versions of Litecoin. |
| 51 | + |
| 52 | +Testing |
| 53 | +------- |
| 54 | + |
| 55 | +Testing and code review is the bottleneck for development; we get more pull |
| 56 | +requests than we can review and test. Please be patient and help out, and |
| 57 | +remember this is a security-critical project where any mistake might cost people |
| 58 | +lots of money. |
| 59 | + |
| 60 | +### Automated Testing |
| 61 | + |
| 62 | +Developers are strongly encouraged to write unit tests for new code, and to |
| 63 | +submit new unit tests for old code. |
| 64 | + |
| 65 | +Unit tests for the core code are in `src/test/`. To compile and run them: |
| 66 | + |
| 67 | + cd src; make -f makefile.unix test |
| 68 | + |
| 69 | +Unit tests for the GUI code are in `src/qt/test/`. To compile and run them: |
| 70 | + |
| 71 | + qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro |
| 72 | + make -f Makefile.test |
| 73 | + ./litecoin-qt_test |
| 74 | + |
0 commit comments