README.md

   1 Zcash 2.0.2
   2 <img align="right" width="120" height="80" src="doc/imgs/logo.png">
   3 ===========
   4
   5 What is Zcash?
   6 --------------
   7
   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
  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).
  13
  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
  17 blockchain has reached a significant size.
  18
  19 <p align="center">
  20   <img src="doc/imgs/zcashd_screen.gif" height="500">
  21 </p>
  22
  23 #### :lock: Security Warnings
  24
  25 See important security warnings on the
  26 [Security Information page](https://z.cash/support/security/).
  27
  28 **Zcash is experimental and a work-in-progress.** Use at your own risk.
  29
  30 ####  :ledger: Deprecation Policy
  31
  32 This release is considered deprecated 16 weeks after the release day. There
  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
  35 height.
  36
  37 ## Getting Started
  38
  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.
  40
  41 ### Need Help?
  42
  43 * :blue_book: See the documentation at the [ReadtheDocs](https://zcash.readthedocs.io)
  44   for help and more information.
  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)
  47
  48 Participation in the Zcash project is subject to a
  49 [Code of Conduct](code_of_conduct.md).
  50
  51 ### Building
  52
  53 Build Zcash along with most dependencies from source by running:
  54
  55 ```
  56 ./zcutil/build.sh -j$(nproc)
  57 ```
  58
  59 Currently only Linux is officially supported.
  60
  61 License
  62 -------
  63
  64 For license information see the file [COPYING](COPYING).