diff --git a/README.md b/README.md index dce8041dd..0d2159270 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,33 @@ -Zdash 1.0.9 +HUSH 1.0.9 ============= -What is Zdash? +What is HUSH? -------------- -[Zdash] is a private implementation of the "Zerocash" protocol forked from [Zcash]. +![Logo](doc/hush/hush.png "Logo") + +HUSH (formerly Zdash) is a private implementation of the "Zerocash" protocol forked from [ZCash](https://z.cash/). 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. -This software is the Zdash client. It downloads and stores the entire history -of Zdash transactions; depending on the speed of your computer and network +This software is the HUSH node and command-line client. It downloads and stores the entire history +of HUSH 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. -**Zdash is unfinished and highly experimental.** Use at your own risk. +**HUSH is unfinished and highly experimental.** Use at your own risk! TEAM ---- -Axel Karlsson: [@sparkit] Community manager, general communications. - -Iolar Demartini Junior: [@demartini] Web Developer (Front End). - -Joseph Stuhlman: [@joseph] Dev, general communications. +* Axel Karlsson: [@sparkit] Community manager, general communications. +* Iolar Demartini Junior: [@demartini] Web Developer (Front End). +* Joseph Stuhlman: [@joseph] Dev, general communications. +* David Mercer: [@radix42] Lead Developer - -* You can join our team and make contributions +* You can join our team too and make contributions Slack ----- @@ -36,8 +36,10 @@ https://zdash-slack.herokuapp.com/ //invite Building -------- - -Build Zdash along with most dependencies from source by running +The following build process generally applies to Ubuntu (and similar) Linux +distributions. For best results it is recommended to use Ubuntu Linux 16.04 +or later. +Build HUSH along with most dependencies from source by running Get dependencies: ```{r, engine='bash'} @@ -47,21 +49,27 @@ sudo apt-get install \ zlib1g-dev wget bsdmainutils automake ``` -Install +Create a HUSH configuration file (*important*): +``` +mkdir -p ~/.hush +echo "rpcuser=username" >> ~/.hush/hush.conf +echo "rpcpassword=`head -c 32 /dev/urandom | base64`" >>~/.hush/hush.conf +``` + +Install HUSH ```{r, engine='bash'} -#pull -git clone https://github.com/J-Stuhlman/zdash.git -cd zdash +# pull +git clone https://github.com/MyHush/hush.git +cd hush # fetch key ./zcutil/fetch-params.sh # Build ./zcutil/build.sh -j$(nproc) -# Run -./src/zcashd +# Run a HUSH node +./src/hushd ``` - -Currently only Linux is officially supported. +Currently only Linux is officially supported. Windows/Mac OS X versions are in the works... Deprecation Policy ------------------ @@ -73,14 +81,19 @@ height and can be explicitly disabled. Where do I begin? ----------------- -We have a guide for joining the main Zcash network: -https://github.com/zcash/zcash/wiki/1.0-User-Guide +As a reference a guide for joining the main Zcash network may be used: +https://github.com/zcash/zcash/wiki/1.0-User-Guide#using-zcash +Users should *not* follow this guide blindly since it applies to ZCash instead of HUSH! +The section of using the command line is relevant to HUSH. ### Need Help? * See the documentation at the [Zcash Wiki](https://github.com/zcash/zcash/wiki) - for help and more information. + for help and more general information. + +### Not content with command line use of HUSH? +A [HUSH GUI Wallet](https://github.com/vaklinov/hush-swing-wallet-ui) exists and is maintained by an independent developer as a separate project. Please read about the known issues and limitations before using the wallet. License ------- diff --git a/doc/hush/hush.png b/doc/hush/hush.png new file mode 100644 index 000000000..2ff1f6b3c Binary files /dev/null and b/doc/hush/hush.png differ