Refactor README docs to avoid duplication.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
parent
ede2ebff4e
commit
666a401f42
52
README.md
52
README.md
|
@ -1,24 +1,19 @@
|
|||
Zcash
|
||||
=====
|
||||
|
||||
https://z.cash/
|
||||
|
||||
Where do I begin?
|
||||
-----------------
|
||||
|
||||
We have a guide for joining the public testnet: https://github.com/zcash/zcash/wiki/Beta-Guide
|
||||
Zcash 1.0.0-rc2
|
||||
===============
|
||||
|
||||
What is Zcash?
|
||||
--------------
|
||||
|
||||
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 preserves confidentiality of transaction metadata. Technical details are
|
||||
[Zcash](https://z.cash/) 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 that
|
||||
preserves confidentiality of transaction metadata. Technical details are
|
||||
available in our [Protocol Specification](https://github.com/zcash/zips/raw/master/protocol/protocol.pdf).
|
||||
|
||||
**Zcash is unfinished and highly experimental.** Use at your own risk.
|
||||
|
||||
Participation in the Zcash project is subject to a [Code of Conduct](code_of_conduct.md).
|
||||
This software is the Zcash client. It downloads and stores the entire history
|
||||
of Zcash transactions; depending on the speed of your computer and network
|
||||
connection, the synchronization process could take a day or more once the
|
||||
block chain has reached a significant size.
|
||||
|
||||
Security Warnings
|
||||
-----------------
|
||||
|
@ -26,9 +21,30 @@ Security Warnings
|
|||
See important security warnings in
|
||||
[doc/security-warnings.md](doc/security-warnings.md).
|
||||
|
||||
**Zcash is unfinished and highly experimental.** Use at your own risk.
|
||||
|
||||
Where do I begin?
|
||||
-----------------
|
||||
|
||||
We have a guide for joining the public testnet:
|
||||
https://github.com/zcash/zcash/wiki/Beta-Guide
|
||||
|
||||
### Need Help?
|
||||
|
||||
* See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki)
|
||||
for help and more information.
|
||||
* Ask for help on the [Zcash](https://forum.z.cash/) forum.
|
||||
|
||||
Participation in the Zcash project is subject to a
|
||||
[Code of Conduct](code_of_conduct.md).
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
Build Zcash along with most dependencies from source by running
|
||||
./zcutil/build.sh. Currently only Linux is supported.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Zcash is released under the terms of the MIT license. See [COPYING](COPYING) for more
|
||||
information or see http://opensource.org/licenses/MIT.
|
||||
|
||||
For license information see the file [COPYING](COPYING).
|
||||
|
|
|
@ -1,25 +0,0 @@
|
|||
Zcash Core 1.0.0-rc2
|
||||
====================
|
||||
|
||||
[Zcash](https://z.cash/) is the Zcash client. It downloads and stores the entire history of Zcash transactions; depending on the speed of your computer and network connection, the synchronization process could take a day or more once the blockchain has reached a significant size.
|
||||
|
||||
### Need Help?
|
||||
|
||||
* See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki) for help and more information. NOTE: Other documentation in this directory may be out of date and inaccurate.
|
||||
* Ask for help on the [Zcash](https://forum.z.cash/) forums.
|
||||
|
||||
Building
|
||||
--------
|
||||
|
||||
Build Zcash along with most dependencies from source by running ./zcutil/build.sh. Currently only Linux is supported.
|
||||
|
||||
License
|
||||
---------------------
|
||||
Distributed under the [MIT software license](http://www.opensource.org/licenses/mit-license.php).
|
||||
|
||||
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
|
||||
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
|
||||
|
||||
Certain files under the ``src/qt/`` and ``scripts/img/`` directories are distributed under the
|
||||
LGPL or GPL licenses. Dependencies downloaded as part of the build process may be covered by other
|
||||
open source licenses. For further details see ``contrib/DEBIAN/copyright``.
|
Loading…
Reference in New Issue