diff --git a/README.md b/README.md index 13b7f81..0aeb844 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,23 @@ # SilentDragonLite -SilentDragonLite is a lightwallet for HUSH ($HUSH) runs on Linux and Windows which does not require you to download the full blockchain. This is experimental software under active development! +

+ + MyHushTeam's Twitter + + follow on Twitter + + follow on Mastodon + + MyHushTeam's Reddit +

+SilentDragonLite is a lightwallet for HUSH ($HUSH) runs on Linux and Windows which does not require you to download the full blockchain. This is experimental software under active development! - +![HushChat screenshot](hushchat-screenshot.png) ## PRIVACY NOTICE @@ -16,24 +30,49 @@ a custom block explorer URL as well. * explorer.hush.is for explorer links (optional) * various community-run lite wallet servers to provide basic functionality (required) -This means your IP address is known to these servers. Enable Tor setting in SilentDragon to prevent this, or better yet, use TAILS: https://tails.boum.org/ +This means your IP address is known to these servers. Enable Tor setting in your wallet to prevent this, or better yet, use TAILS: https://tails.boum.org/ or https://qubes-os.org ## Installation -Go to the releases page and grab the latest installers or binary. https://git.hush.is/hush/SilentDragonLite/releases +Choose to install a binary release or compile it yourself. +For Arch Linux users, we have a silentdragonlite package on [AUR](https://aur.archlinux.org/). + +### Option 1: Binary Release +Go to the [releases page](https://git.hush.is/hush/SilentDragonLite/releases) and grab the latest binary. + +### Option 2: Compile Release Yourself + +* SilentDragonLite is written in C++ 14, and can be compiled with g++/clang++/visual c++. +* It also depends on Qt5, which you can get from [here](https://www.qt.io/download) or install using your Linux version's package manager. +* You'll need Rust v1.41 + -## Install Torsocks (or any other Socks service for TOR) on Ubuntu 18.04 +#### Building on Linux + +##### Ubuntu 18.04 and 20.04: +```shell script +sudo apt-get -y install qt5-default qt5-qmake libqt5websockets5-dev qtcreator +git clone https://git.hush.is/hush/SilentDragonLite +cd SilentDragonLite +# the next step will take potentially a long time for slower systems +# Be Patient and please report compiler problems! +./build.sh +./SilentDragonLite ``` + +### Other notes + +#### Install Torsocks (or any other Socks service for TOR) on Ubuntu 18.04 +```shell script sudo apt update sudo apt install torsocks ``` -## Connection to our TOR onion service Server +#### Connection to our TOR onion service Server ``` * Open SDL Edit->Settings->LightwalletServer->6onaaujm4ozaokzu.onion:80 * Open the folder of SDL in a Terminal -> Enter: TORSOCKS_LOG_LEVEL=1 torsocks -i ./SilentDragonLite ``` -## Note Management +### Note Management SilentDragonLite does automatic note and utxo management, which means it doesn't allow you to manually select which address to send outgoing transactions from. It follows these principles: * Defaults to sending shielded transactions, which are now enforced via consensus rules @@ -42,18 +81,6 @@ SilentDragonLite does automatic note and utxo management, which means it doesn't * Will automatically shield your transparent funds at the first opportunity * When sending an outgoing transaction to a shielded address, SilentDragonLite can decide to use the transaction to additionally shield your transparent funds (i.e., send your transparent funds to your own shielded address in the same transaction) -## Compiling from source -* SilentDragonLite is written in C++ 14, and can be compiled with g++/clang++/visual c++. -* It also depends on Qt5, which you can get from [here](https://www.qt.io/download). -* You'll need Rust v1.41 + - -## Building on Linux +## Support -``` -git clone https://git.hush.is/hush/SilenDragonLite -cd SilentDragonLite -# the next step will take potentially a long time for slower systems -# Be Patient and please report compiler problems! -./build.sh -./SilentDragonLite -``` +For support or other questions, join us on [Telegram](https://hush.is/telegram), or tweet at [@MyHushTeam](https://twitter.com/MyHushTeam), or toot at our [Mastodon](https://fosstodon.org/@myhushteam) or join [Telegram Support](https://hush.is/telegram_support).