From 293e4f015b811a03e4059cab38c92e7b42978bcc Mon Sep 17 00:00:00 2001 From: Sean Bowe Date: Wed, 20 Jan 2016 00:37:45 -0700 Subject: [PATCH] Updated README and COPYING. --- COPYING | 1 + README.md | 82 ++++++------------------------------------------------- 2 files changed, 9 insertions(+), 74 deletions(-) diff --git a/COPYING b/COPYING index cae0f5b6f..768ebdd4b 100644 --- a/COPYING +++ b/COPYING @@ -1,3 +1,4 @@ +Copyright (c) 2016 The Zcash Core developers Copyright (c) 2009-2015 The Bitcoin Core developers Permission is hereby granted, free of charge, to any person obtaining a copy diff --git a/README.md b/README.md index 4fe6a8749..f673f0959 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,19 @@ -Bitcoin Core integration/staging tree +Zcash Core integration/staging tree ===================================== -[![Build Status](https://travis-ci.org/bitcoin/bitcoin.svg?branch=master)](https://travis-ci.org/bitcoin/bitcoin) +https://z.cash/ -https://www.bitcoin.org - -What is Bitcoin? +What is Zcash? ---------------- -Bitcoin is an experimental new digital currency that enables instant payments to -anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate -with no central authority: managing transactions and issuing money are carried -out collectively by the network. Bitcoin Core is the name of open source -software which enables the use of this currency. +Zcash is an implementation of the "zerocash" protocol. Based on Bitcoin's code, it intends to +offer a far higher standard of privacy and anonymity through a sophisticiated zero-knowledge +proving scheme which perserves confidentiality of transaction metadata. -For more information, as well as an immediately useable, binary version of -the Bitcoin Core software, see https://www.bitcoin.org/en/download. +**Zcash is unfinished and highly experimental.** Use at your own risk. License ------- -Bitcoin Core is released under the terms of the MIT license. See [COPYING](COPYING) for more +Zcash Core is released under the terms of the MIT license. See [COPYING](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 Bitcoin -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](https://lists.linuxfoundation.org/mailman/listinfo/bitcoin-dev) - -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/developer-notes.md](doc/developer-notes.md)) or are -controversial. - -The `master` branch is regularly built and tested, but is not guaranteed to be -completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created -regularly to indicate new official, stable release versions of Bitcoin. - -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` - -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 [BitcoinPullTester](https://github.com/BitcoinPullTester). 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/bitcoin/QA/ for how to create a test plan. - -Translations ------------- - -Changes to translations as well as new translations can be submitted to -[Bitcoin Core's Transifex page](https://www.transifex.com/projects/p/bitcoin/). - -Translations are periodically pulled from Transifex and merged into the git repository. See the -[translation process](doc/translation_process.md) 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 subscribe to the [mailing list](https://groups.google.com/forum/#!forum/bitcoin-translators).