zcash-patched-for-explorer/README.md

71 lines
2.5 KiB
Markdown

***Please note, this repository is obsolete and will be removed soon. It had changes needed
to support the Bitcore Insight Explorer, but those changes have been incorporated into
[version 2.0.7 in the main Zcash repository](https://github.com/zcash/zcash/tree/v2.0.7).
Please see the
[Insight Block Explorer Guide](https://zcash.readthedocs.io/en/latest/rtd_pages/insight_explorer.html).***
Zcash 2.0.0
<img align="right" width="120" height="80" src="doc/imgs/logo.png">
===========
What is Zcash?
--------------
[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
through a sophisticated 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).
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
blockchain has reached a significant size.
<p align="center">
<img src="doc/imgs/zcashd_screen.gif" height="500">
</p>
#### :lock: Security Warnings
See important security warnings on the
[Security Information page](https://z.cash/support/security/).
**Zcash is experimental and a work-in-progress.** Use at your own risk.
#### :ledger: Deprecation Policy
This release is considered deprecated 16 weeks after the release day. There
is an automatic deprecation shutdown feature which will halt the node some
time after this 16 week time period. The automatic feature is based on block
height.
## Getting Started
Please see our [user guide](https://zcash.readthedocs.io/en/latest/rtd_pages/rtd_docs/user_guide.html) for joining the main Zcash network.
### Need Help?
* :blue_book: See the documentation at the [ReadtheDocs](https://zcash.readthedocs.io)
for help and more information.
* :incoming_envelope: Ask for help on the [Zcash](https://forum.z.cash/) forum.
* :mag: Chat with our support community on [Rocket.Chat](https://chat.zcashcommunity.com/channel/user-support)
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 -j$(nproc)
```
Currently only Linux is officially supported.
License
-------
For license information see the file [COPYING](COPYING).