Bitcoin integration/staging tree
TypeScript C++ C Python IDL Shell
Clone or download
Pull request Compare This branch is 7 commits ahead of bryan-mills:0.8.1.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
contrib
doc
share
src
.gitattributes
.gitignore
COPYING
INSTALL
README.md
bytecoin-qt.pro
bytecoin.conf

README.md

Bytecoin integration/staging tree

Copyright (c) 2009-2012 Bytecoin Developers

What is Bytecoin?

Bytecoin is an experimental new digital currency that enables instant payments to anyone, anywhere in the world. Bytecoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Bytecoin is also the name of the open source software which enables the use of this currency.

Running The Client

To run the client compile from source or fetch the clients from the original thread. To join the network the bytecoin.conf file must be placed in the appdata/bytecoin directory

License

Bytecoin is released under the terms of the MIT license. See COPYING for more information or see http://opensource.org/licenses/MIT.

Development process

Developers work in their own trees, then submit pull requests when they think their feature or bug fix is ready.

If it is a simple/trivial/non-controversial change, then one of the Bytecoin development team members simply pulls it.

If it is a more complicated or potentially controversial change, then the patch submitter will be asked to start a discussion (if they haven't already) on the mailing list.

The patch will be accepted if there is broad consensus that it is a good thing. Developers should expect to rework and resubmit patches if the code doesn't match the project's coding conventions (see doc/coding.txt) or are controversial.

The master branch is regularly built and tested, but is not guaranteed to be completely stable. Tags are created regularly to indicate new official, stable release versions of Bytecoin.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test. Please be patient and help out, 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 for new code, and to submit new unit tests for old code.

Unit tests for the core code are in src/test/. To compile and run them:

cd src; make -f makefile.linux test

Unit tests for the GUI code are in src/qt/test/. To compile and run them:

qmake BYTECOIN_QT_TEST=1 -o Makefile.test bytecoin-qt.pro
make -f Makefile.test
./Bytecoin-Qt

Every pull request is built for both Windows and Linux on a dedicated server, and unit and sanity tests are automatically run. The binaries produced may be used for manual QA testing -- a link to them will appear in a comment on the pull request posted by 'BytecoinPullTester'. See https://github.com/TheBlueMatt/test-scripts for the build/test scripts.

Manual Quality Assurance (QA) Testing

Large changes should have a test plan, and should be tested by somebody other than the developer who wrote the code.

See https://github.com/bytecoin/QA/ for how to create a test plan.