zcash-patched-for-explorer/doc/README.md

78 lines
3.1 KiB
Markdown
Raw Normal View History

2016-01-23 14:00:35 -08:00
Zcash Core 0.11.2
=====================
2013-05-19 21:30:00 -07:00
Setup
---------------------
2016-01-23 14:00:35 -08:00
[Zcash Core](https://z.cash/) is the original Zcash client and it builds the backbone of the network. However, it downloads and stores the entire history of Zcash transactions (which is currently several GBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
Running
---------------------
2016-01-23 14:00:35 -08:00
The following are some helpful notes on how to run Zcash on your native platform.
### Unix
2016-01-23 14:00:35 -08:00
You need the Qt4 run-time libraries to run Zcash-Qt. On Debian or Ubuntu:
sudo apt-get install libqtgui4
2013-05-19 21:30:00 -07:00
Unpack the files into a directory and run:
2016-01-23 14:00:35 -08:00
- bin/32/zcash-qt (GUI, 32-bit) or bin/32/zcashd (headless, 32-bit)
- bin/64/zcash-qt (GUI, 64-bit) or bin/64/zcashd (headless, 64-bit)
2013-05-19 21:30:00 -07:00
### Windows
2016-01-23 14:00:35 -08:00
Unpack the files into a directory, and then run zcash-qt.exe.
### OS X
2016-01-23 14:00:35 -08:00
Drag Zcash-Qt to your applications folder, and then run Zcash-Qt.
### Need Help?
2016-01-23 14:00:35 -08:00
* See the documentation at the [Zcash Wiki](https://github.com/Electric-Coin-Company/zcash/wiki)
for help and more information.
2016-01-23 14:00:35 -08:00
* Ask for help on [#zcash](https://webchat.oftc.net/?channels=zcash) on OFTC. If you don't have an IRC client use [webchat here](https://webchat.oftc.net/?channels=zcash).
* Ask for help on the [Zcash](https://forum.z.cash/) forums.
Building
2013-05-19 21:30:00 -07:00
---------------------
2016-01-23 14:00:35 -08:00
The following are developer notes on how to build Zcash on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
- [OS X Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
2015-05-16 09:00:50 -07:00
- [Gitian Building Guide](gitian-building.md)
Development
---------------------
2016-01-23 14:00:35 -08:00
The Zcash repo's [root README](https://github.com/Electric-Coin-Company/zcash/blob/zc.v0.11.2.latest/README.md) contains relevant information on the development process and automated testing.
- [Developer Notes](developer-notes.md)
2013-05-19 21:30:00 -07:00
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Translation Process](translation_process.md)
2015-05-22 04:09:56 -07:00
- [Translation Strings Policy](translation_strings_policy.md)
2013-05-19 21:30:00 -07:00
- [Unit Tests](unit-tests.md)
2015-05-16 09:00:50 -07:00
- [Unauthenticated REST Interface](REST-interface.md)
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)
### Resources
2016-01-23 14:00:35 -08:00
* Discuss on the [Zcash](https://forum.z.cash/) forums.
* Discuss on [#zcash](https://webchat.oftc.net/?channels=zcash) on OFTC. If you don't have an IRC client use [webchat here](https://webchat.oftc.net/?channels=zcash).
### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Files](files.md)
- [Tor Support](tor.md)
- [Init Scripts (systemd/upstart/openrc)](init.md)
License
---------------------
2014-12-12 20:09:33 -08:00
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.