Particl Core integration/staging tree
Clone or download
Pull request Compare This branch is 977 commits ahead, 7 commits behind bitcoin:master.
Permalink
Failed to load latest commit information.
.github Merge branch 'bitcoin' into particl_dev Oct 1, 2018
.travis Merge branch 'bitcoin' into particl_dev Oct 4, 2018
.tx tx: Update transifex slug 016x→017x Aug 2, 2018
build-aux/m4 Merge branch 'master_btc' into particl_dev Jul 27, 2018
build-particl-qt-Desktop-Debug Merge branch 'bitcoin' into particl_dev Sep 7, 2018
build_msvc appveyor: Use clcache to speed up build Sep 3, 2018
contrib Merge branch 'bitcoin' into particl_dev Oct 4, 2018
depends Use latest hidapi. Fixes unreliable usb in osx. Oct 13, 2018
doc usb: Initialise Ledger error code. Oct 11, 2018
share Merge branch 'bitcoin' into particl_dev Aug 25, 2018
src Merge branch 'bitcoin' into particl_dev Oct 16, 2018
test Merge branch 'bitcoin' into particl_dev Oct 8, 2018
.appveyor.yml appveyor: trivial build cache modifications Oct 5, 2018
.editorconfig unpassing categories Oct 25, 2017
.gitattributes Separate protocol versioning from clientversion Oct 29, 2014
.gitignore Add to gitignore. Aug 22, 2018
.travis.yml Merge branch 'bitcoin' into particl_dev Oct 8, 2018
CONTRIBUTING.md Merge branch 'master_btc' into particl_dev Jul 30, 2018
COPYING Add Particl development copy May 2, 2018
INSTALL.md Update INSTALL landing redirection notice for build instructions. Oct 5, 2016
Makefile.am Merge branch 'bitcoin' into particl_dev Oct 8, 2018
README.md Merge branch 'master_btc' into particl_dev Jul 23, 2018
autogen.sh Add "export LC_ALL=C" to all shell scripts Jun 14, 2018
configure.ac Merge branch 'bitcoin' into particl_dev Sep 28, 2018
libparticlconsensus.pc.in Renamed bitcoinconsensus.h to particlconsensus.h Jul 11, 2017

README.md

Particl Core integration/staging tree

Build Status

https://particl.io

What is Particl?

An open source, decentralized privacy platform built for global person to person eCommerce.

For more information, as well as an immediately useable, binary version of the Particl Core software, see https://particl.io.

Getting Started

A new Particl wallet will need an HD master key loaded and an initial account derived before it will be functional.

The GUI programs will guide you through the initial setup.

It is recommended to use a mnemonic passphrase. To generate a new passphrase see the mnemonic rpc command. Loading the new mnemonic with the extkeyimportmaster command will setup the master HD key and first account.

To create an initial new HD master key and account from random data, start particld or particl-qt with the parameter: -createdefaultmasterkey.

Remember to backup your passphrase and/or wallet.dat file!

License

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

Development Process

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 Particl Core.

The contribution workflow is described in CONTRIBUTING.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 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.

There are also regression and integration tests, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies 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.