Skip to content

Commit

Permalink
1st Pass edit on Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GroundRod authored and GroundRod committed Sep 24, 2014
1 parent 667f5fb commit 309df91
Showing 1 changed file with 22 additions and 32 deletions.
54 changes: 22 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,27 @@
IXCoin Core integration/staging tree
=====================================

http://www.bitcoin.org

Copyright (c) 2009-2014 IXCoin Core Developers
Copyright (c) 2011-2014 IXCoin Core Developers

What is IXCoin?
----------------

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

Created by Thomas Nasakioto, IXCoin uses the same peer-to-peer technology to
operate with no central authority: managing transactions and issuing money are
carried out collectively by the network.

IXCoin Core is the name of this open source software which enables the use of
that currency.

For more information, as well as an immediately useable, binary version of
the IXCoin Core software, see http://www.ixcoin.org
For more information, see https://bitcointalk.org/index.php?topic=230141

A new IXcoin Foundation has recently formed in 2014, this is ongoing, with the
intention that the orignal http://www.ixcoin.org website be maintained and
kept current, watch there for updates as well as useable binary versions of
the IXCoin Core software

License
-------
Expand All @@ -32,37 +38,20 @@ their feature or bug fix is ready.
If it is a simple/trivial/non-controversial change, then one of the IXCoin
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](http://sourceforge.net/mailarchive/forum.php?forum_name=ixcoin-development).

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.md](doc/coding.md)) or are
controversial.

The `master` branch is regularly built and tested, but is not guaranteed to be
completely stable. [Tags](https://github.com/ixcoin/ixcoin/tags) are created
regularly to indicate new official, stable release versions of IXCoin.

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.
Testing and code review is the bottleneck for development;
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 can be compiled and run (assuming they weren't disabled in configure) with: `make check`
submit new unit tests for old code. Unit tests can be compiled and run
(assuming they weren't disabled in configure) with: `make check`

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 [IXCoinPullTester](https://github.com/IXCoinPullTester). See https://github.com/TheBlueMatt/test-scripts
for the build/test scripts.

### Manual Quality Assurance (QA) Testing

Expand All @@ -72,6 +61,7 @@ See https://github.com/ixcoin/QA/ for how to create a test plan.

Translations
------------
We need help here!

Changes to translations as well as new translations can be submitted to
[IXCoin Core's Transifex page](https://www.transifex.com/projects/p/ixcoin/).
Expand Down

0 comments on commit 309df91

Please sign in to comment.