CitrusCash
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3413fa8 Mar 17, 2018
Permalink
Failed to load latest commit information.
.tx Initial commit Mar 16, 2018
build-aux/m4 Initial commit Mar 16, 2018
citrus-docs Initial commit Mar 16, 2018
contrib Initial commit Mar 16, 2018
depends Initial commit Mar 16, 2018
doc Initial commit Mar 16, 2018
qa Initial commit Mar 16, 2018
share Initial commit Mar 16, 2018
src Fix & new ver Mar 17, 2018
.gitattributes Initial commit Mar 16, 2018
.gitignore Initial commit Mar 16, 2018
.travis.yml Initial commit Mar 16, 2018
CONTRIBUTING.md Initial commit Mar 16, 2018
COPYING Initial commit Mar 16, 2018
INSTALL Initial commit Mar 16, 2018
Makefile.am Initial commit Mar 16, 2018
README.md Update README.md Mar 17, 2018
autogen.sh Initial commit Mar 16, 2018
configure.ac Fix & new ver Mar 17, 2018
libcitrusconsensus.pc.in Initial commit Mar 16, 2018

README.md

Citrus Core staging tree 1.0.3.1

What is Citrus?

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

License

Citrus 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 meant to be stable. Development is normally done in separate branches. Tags are created to indicate new official, stable release versions of Citrus 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

There are also regression and integration tests of the RPC interface, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: qa/pull-tester/rpc-tests.py

The Travis CI system makes sure that every pull request is built for Windows and Linux, OS X, and that unit and sanity tests are automatically run.

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.

Translations

Changes to translations as well as new translations can be submitted to Citrus Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process 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 follow the forum.