DragonX/dragonx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update a bunch of docs by adding a banner, delete a bunch of known bitrot docs; does not update release-process.md.

Browse Source
This commit is contained in:
Nathan Wilcox
2016-04-12 16:40:30 -07:00
parent f2e157ab25
commit fb537854ff
50 changed files with 32 additions and 850 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
doc/README.md
View File

@@ -1,74 +1,17 @@
Zcash Core 0.11.2
=====================
Zcash Core 0.11.2.z2
====================
Setup
---------------------
[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
---------------------
The following are some helpful notes on how to run Zcash on your native platform.
### Unix
You need the Qt4 run-time libraries to run Zcash-Qt. On Debian or Ubuntu:
sudo apt-get install libqtgui4
Unpack the files into a directory and run:
- 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)
### Windows
Unpack the files into a directory, and then run zcash-qt.exe.
### OS X
Drag Zcash-Qt to your applications folder, and then run Zcash-Qt.
[Zcash](https://z.cash/) is the Zcash client. 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.
### Need Help?
* See the documentation at the [Zcash Wiki](https://github.com/Electric-Coin-Company/zcash/wiki)
for help and more information.
* 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).
* 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
---------------------
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)
- [Gitian Building Guide](gitian-building.md)
Development
---------------------
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)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Translation Process](translation_process.md)
- [Translation Strings Policy](translation_strings_policy.md)
- [Unit Tests](unit-tests.md)
- [Unauthenticated REST Interface](REST-interface.md)
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)
### Resources
* 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)
Build Zcash along with most dependencies from source by running ./zcutil/build.sh. Currently only linux is supported.
License
---------------------