diff --git a/README.md b/README.md index 31538216a..be9b7bc72 100644 --- a/README.md +++ b/README.md @@ -1,75 +1,137 @@ -# Hush +

+ +

-## What is Hush? +

-![Logo](doc/hush/hush0.png "Logo") +| Introduction | Install | Compile | FAQ | Documentation | +| :---: | :---: | :---: | :---: | :---: | +| [What is Hush?](#what-is-hush) | [Windows 10 - Video Tutorial](#) | [Build on Debian or Ubuntu](#) | [Where can I buy Hush?](#) | [Cross compiling Windows binaries](#) +| [Why not GitHub?](#banned-by-github) | [Mac - Guideline](#) | [Build on Arch](#) | [Can I mine with CPU or GPU?](#) | [Hush DevOps for pools and CEXs](https://git.hush.is/hush/docs/src/branch/master/advanced/devops.md) +| [What is HushChat?](#) | [Download for Android](https://storage.hush.land/hush-sda/SilentDragonXAndroid.apk) | [Build on Fedora](#) | [What is DragonX?](https://dragonx.is) | [Earn bounty](#) +| [What is SilentDagon?](#) | [Deb package - Guideline](#) | [Ubuntu 16.04](#) | [Where can I spend Hush?](#) | [Cross compiling from amd64 to arm64](https://git.hush.is/hush/docs/src/branch/master/advanced/cross-compile-hush-full-node-to-aarch64-with-docker.md) + +

+ +# What is Hush? Hush implements Extreme Privacy via blockchain tech. We have our own genesis block. We are not a chain fork (copy) of another coin. We are based on Bitcoin code, with sophisticated zero-knowledge mathematics added for privacy. This keeps your transaction metadata private! -### This repository - 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, it will likely take a few hours at least, but -some people report full nodes syncing in less than 1.5 hours. A competing privacy -coin takes over 24 hours to sync their full nodes because of Sprout Transactions, lulz. +some people report full nodes syncing in less than 1.5 hours. -### BANNED BY GITHUB +# Banned by GitHub In working on this release, Duke Leto was suspended from Github, which gave Hush developers -the impetus to completely leave that racist and censorship-loving platform. - -Hush now has it's own [git.hush.is](https://git.hush.is/hush) Gitea instance, -because we will not be silenced by Microsoft. - -All Hush software will be released from git.hush.is and hush.is, downloads from any other +the impetus to completely leave that racist and censorship-loving platform. Hush now has it's own [git.hush.is](https://git.hush.is/hush) Gitea instance, +because we will not be silenced by Microsoft. All Hush software will be released from git.hush.is and hush.is, downloads from any other domains should be assumed to be backdoored. **Hush is unfinished and highly experimental.** Use at your own risk! Just like Bitcoin. -## Installing +# Build on Debian or Ubuntu -You can either compile it yourself or you can install a binary which was compiled by us. -Please refer to the instructions which apply to you below: +```sh +# install build dependencies +sudo apt-get install build-essential pkg-config libc6-dev m4 g++-multilib \ + autoconf libtool ncurses-dev unzip git zlib1g-dev wget \ + bsdmainutils automake curl unzip nano libsodium-dev cmake +# clone git repo +git clone https://git.hush.is/hush/hush3 +cd hush3 +# Build +# This uses 3 build processes, you need 2GB of RAM for each. +./build.sh -j3 +``` +Video Tutorial: https://videos.hush.is/w/3kKQt81r7UUPWLHVuwK2BZ -* See [INSTALL.md](INSTALL.md) to compile from source on Linux and to cross-compile for Windows -* See [INSTALL-BIN.md](INSTALL-BIN.md) to install pre-compiled binary on Linux +# Build on Arch -### Claiming Funds From Old Hush Wallets +```sh +# install build dependencies +sudo pacman -S gcc libsodium lib32-zlib unzip wget git python rust curl autoconf cmake +# clone git repo +git clone https://git.hush.is/hush/hush3 +cd hush3 +# Build +# This uses 3 build processes, you need 2GB of RAM for each. +./build.sh -j3 +``` -If you have an older wallet, then refer to [OLD_WALLETS.md](OLD_WALLETS.md). +# Build on Fedora -### Official Explorers +```sh +# install build dependencies +sudo dnf install make automake gcc gcc-c++ kernel-devel cmake libtool ncurses-devel patch -y +# clone git repo +git clone https://git.hush.is/hush/hush3 +cd hush3 +# Build +# This uses 3 build processes, you need 2GB of RAM for each. +./build.sh -j3 +``` + +# Install on Windows 10 + +Video Tutorial: https://videos.hush.is/w/oGXff7of3EjmGENtDtYTUX + +# Install on ARM Architecture + +1. [Download the latest debian package](https://git.hush.is/attachments/ade3f699-6a02-4f1d-af25-04d21029be48). +2. Install the Debian package: `sudo dpkg -i hush-3.10.2-aarch64.deb`. +3. Run with: `hushd`. + +# Building On Ubuntu 16.04 and older systems + +Some older compilers may not be able to compile modern code, such as gcc 5.4 which comes with Ubuntu 16.04 by default. Here is how to install gcc 7 on Ubuntu 16.04. Run these commands as root: + +``` +add-apt-repository ppa:ubuntu-toolchain-r/test && \ +apt update && \ +apt-get install -y gcc-7 g++-7 && \ + update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 60 && \ + update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-7 60 +``` + +# Build on Mac + +``` +sudo port update +sudo port upgrade outdated +sudo port install qt5 + +# clone git repo +git clone https://git.hush.is/hush/hush3 +cd hush3 +# Build +# This uses 3 build processes, you need 2GB of RAM for each. +./build.sh -j3 +``` + +# Installing Hush binaries + +1. [Download the release](https://git.hush.is/hush/hush3/releases) with a .deb file extension. +2. Install the Debian package: `sudo dpkg -i hush-3.10.2-amd64.deb`. +3. Run with: `hushd`. + +# Official Explorers The links for the Official Hush explorers: * [explorer.hush.is](https://explorer.hush.is) * [explorer.hush.land](https://explorer.hush.land) -We are looking for alternate explorers to be run on Tor, i2P and other TLDs, if you are interested -please join Telegram and ask questions. +# Support and Socials -### For system admins +* Telegram: https://hush.is/tg +* Matrix: https://hush.is/matrix +* Twitter: https://hush.is/twitter +* PeerTube https://hush.is/peertube -There is a new systemd user service script so you can easily start/stop/restart your hushd service on your server. -[Try it out today](doc/hushd-systemd.md) and the systemd script is located in the doc directory of the source tree. - -## Support and Socials - -Please feel free to join us on Telegram for official support: -* Main group: https://hush.is/tg -* Support group: https://hush.is/telegram_support -* Mining group: https://hush.is/telegram_mining - -Other socials: -* Twitter: @hushisprivacy -* Matrix: @hush_main:matrix.org -* PeerTube videos.hush.is -* Reddit @Myhush -* Mastodon @myhushteam@fosstodon.org - -## License +# License For license information see the file [COPYING](COPYING).