Browse Source

Fixes to README.md

- Updated table on top of README
- Changed version specific instructions
- Removed SDX link, as that is not Hush
- Added back the Raspberry Pi ARM CPU info back under "Install on ARM Architecture"
- Changed Supportd and Socials section to use native Markdown instead of HTML
- Changed numbered lists to native Markdown format
pull/401/head
jahway603 1 month ago
parent
commit
06e46f7fcd
  1. 38
      README.md

38
README.md

@ -7,9 +7,9 @@
| Introduction | Install | Compile | FAQ | Documentation |
| :---: | :---: | :---: | :---: | :---: |
| [What is Hush?](#what-is-hush) | [Windows 10 - Video Tutorial](#install-on-windows-10) | [Build on Debian or Ubuntu](#build-on-debian-or-ubuntu) | [Where can I buy Hush?](#where-can-i-buy-hush) | [Cross compiling Windows binaries](#windows-cross-compiled-on-linux)
| [Why not GitHub?](#banned-by-github) | [Mac - Guideline](#build-on-mac) | [Build on Arch](#build-on-arch) | [Can I mine with CPU or GPU?](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?](#what-is-hushchat) | [Download for Android](https://storage.hush.land/hush-sda/SilentDragonXAndroid.apk) | [Build on Fedora](#build-on-fedora) | [What is DragonX?](https://dragonx.is) | [Earn bounty](#)
| [What is SilentDagon?](#what-is-silentdagon) | [Deb package - Guideline](#installing-hush-binaries) | [Ubuntu 16.04](#building-on-ubuntu-16-04-and-older-systems) | [Where can I spend Hush?](#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)
| [Why not GitHub?](#banned-by-github) | [Build on Mac](#build-on-mac) | [Build on Arch](#build-on-arch) | [Can I mine with CPU or GPU?](#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?](#what-is-hushchat) | [Debian and Ubuntu](#installing-hush-binaries) | [Build on Fedora](#build-on-fedora) | [What is DragonX?](https://dragonx.is) | [Earn bounty](#)
| [What is SilentDagon?](#what-is-silentdagon) | [Raspberry Pi](#install-on-arm-architecture) | [Build on Ubuntu 16.04 or older](#building-on-ubuntu-16-04-and-older-systems) | [Where can I spend Hush?](#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)
</h3>
@ -20,6 +20,8 @@ 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!
# What is 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
@ -82,9 +84,11 @@ 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`.
Use this if you have a Raspberry Pi or similar computer. Currently, any ARMv7 machine will not be able to build this repo, because the underlying tech (zcash and the zksnark library) do not support that instruction set. This also means that old RaspberryPi devices will not work, unless they have a newer ARMv8-based Raspberry Pi. Raspberry Pi 4 and newer are known to work.
1. [Download the latest Debian package with the AARCH64 designation from the releases page](https://git.hush.is/hush/hush3/releases).
1. Install the Debian package, substituting "VERSION-NUMBER" for the version you have downloaded: `sudo dpkg -i hush-VERSION-NUMBER-aarch64.deb`.
1. Run with: `hushd`.
# Building On Ubuntu 16.04 and older systems
@ -116,8 +120,8 @@ cd hush3
# 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`.
1. Install the Debian package, substituting "VERSION-NUMBER" for the version you have downloaded: `sudo dpkg -i hush-VERSION-NUMBER-amd64.deb`.
1. Run with: `hushd`.
# Official Explorers
@ -146,10 +150,10 @@ cd hush3
./src/hushd
```
# What is SilentDagon?
# What is SilentDragon?
[SilentDragon](https://git.hush.is/hush/SilentDragon) is a desktop wallet for HUSH full node.<br>
[SilentDragonLite](https://git.hush.is/hush/SilentDragonLite) is a desktop wallet that does not require you to download the full blockchain.
* [SilentDragon](https://git.hush.is/hush/SilentDragon) is a desktop wallet for HUSH full node.<br>
* [SilentDragonLite](https://git.hush.is/hush/SilentDragonLite) is a desktop wallet that does not require you to download the full blockchain.
# What is HushChat?
@ -157,12 +161,12 @@ HushChat is a protocol inspired by the design of Signal Protocol, it uses many o
# Can I mine with CPU or GPU?
Only ASIC mining is recommended, HUSH uses Equihash (200,9) algo as Zcash, Horizen or Komodo.
Only ASIC mining is recommended, HUSH uses Equihash (200,9) algo, as does Zcash, Horizen or Komodo.
# Where can I buy Hush?
1. https://nonkyc.io/market/HUSH_BTC
2. https://tradeogre.com/exchange/BTC-HUSH
1. https://tradeogre.com/exchange/BTC-HUSH
# Where can I spend Hush?
@ -170,10 +174,10 @@ Agora market (in progress)
# Support and Socials
* Telegram: <a href="https://hush.is/tg">https://hush.is/tg</a>
* Matrix: <a href="https://hush.is/matrix">https://hush.is/matrix</a>
* Twitter: <a href="https://hush.is/twitter">https://hush.is/twitter</a>
* PeerTube <a href="https://hush.is/peertube">https://hush.is/peertube</a>
* Telegram: [https://hush.is/tg](https://hush.is/tg)
* Matrix: [https://hush.is/matrix](https://hush.is/matrix)
* Twitter: [https://hush.is/twitter](https://hush.is/twitter)
* PeerTube [https://hush.is/peertube](https://hush.is/peertube)
# License

Loading…
Cancel
Save