projects / VerusCoin.git / blame
| Commit | Line | Data |
|---|---|---|
| 94360cd0 | 1 | Zcash 2.0.1-rc1 |
| 48f17280 | 2 | <img align="right" width="120" height="80" src="doc/imgs/logo.png"> |
| 3 | =========== | |
| 559ab225 | 4 | |
| 293e4f01 | 5 | What is Zcash? |
| c2ec2f53 | 6 | -------------- |
| 20d59455 | 7 | |
| 666a401f DH |
8 | [Zcash](https://z.cash/) is an implementation of the "Zerocash" protocol. |
| 9 | Based on Bitcoin's code, it intends to offer a far higher standard of privacy | |
| eb2e2b70 SB |
10 | through a sophisticated zero-knowledge proving scheme that preserves |
| 11 | confidentiality of transaction metadata. Technical details are available | |
| 12 | in our [Protocol Specification](https://github.com/zcash/zips/raw/master/protocol/protocol.pdf). | |
| 20d59455 | 13 | |
| 666a401f DH |
14 | This software is the Zcash client. It downloads and stores the entire history |
| 15 | of Zcash transactions; depending on the speed of your computer and network | |
| 16 | connection, the synchronization process could take a day or more once the | |
| c2b24ccd | 17 | blockchain has reached a significant size. |
| 254c16dd | 18 | |
| 48f17280 | 19 | <p align="center"> |
| 20 | <img src="doc/imgs/zcashd_screen.gif" height="500"> | |
| 21 | </p> | |
| 22 | ||
| 23 | #### :lock: Security Warnings | |
| 8fb1005c | 24 | |
| 10512429 S |
25 | See important security warnings on the |
| 26 | [Security Information page](https://z.cash/support/security/). | |
| 8fb1005c | 27 | |
| 52ca5aac | 28 | **Zcash is experimental and a work-in-progress.** Use at your own risk. |
| 666a401f | 29 | |
| 48f17280 | 30 | #### :ledger: Deprecation Policy |
| ce7e7caf NW |
31 | |
| 32 | This release is considered deprecated 16 weeks after the release day. There | |
| e895b863 NW |
33 | is an automatic deprecation shutdown feature which will halt the node some |
| 34 | time after this 16 week time period. The automatic feature is based on block | |
| 48f17280 | 35 | height. |
| 36 | ||
| 37 | ## Getting Started | |
| ce7e7caf | 38 | |
| 48f17280 | 39 | Please see our [user guide](https://zcash.readthedocs.io/en/latest/rtd_pages/rtd_docs/user_guide.html) for joining the main Zcash network. |
| 666a401f DH |
40 | |
| 41 | ### Need Help? | |
| 42 | ||
| 48f17280 | 43 | * :blue_book: See the documentation at the [ReadtheDocs](https://zcash.readthedocs.io) |
| 666a401f | 44 | for help and more information. |
| 48f17280 | 45 | * :incoming_envelope: Ask for help on the [Zcash](https://forum.z.cash/) forum. |
| 46 | * :mag: Chat with our support community on [Rocket.Chat](https://chat.zcashcommunity.com/channel/user-support) | |
| 666a401f DH |
47 | |
| 48 | Participation in the Zcash project is subject to a | |
| 49 | [Code of Conduct](code_of_conduct.md). | |
| 50 | ||
| 48f17280 | 51 | ### Building |
| 52 | ||
| 53 | Build Zcash along with most dependencies from source by running: | |
| 54 | ||
| 55 | ``` | |
| 56 | ./zcutil/build.sh -j$(nproc) | |
| 57 | ``` | |
| 666a401f | 58 | |
| 48f17280 | 59 | Currently only Linux is officially supported. |
| 666a401f | 60 | |
| 20d59455 CD |
61 | License |
| 62 | ------- | |
| 63 | ||
| 666a401f | 64 | For license information see the file [COPYING](COPYING). |