From 1399c5401f59c7e575b5108b1dae87a30fdf6942 Mon Sep 17 00:00:00 2001 From: Aditya Kulkarni Date: Mon, 15 Oct 2018 20:32:38 -0700 Subject: [PATCH] Update README --- .gitignore | 6 ++++-- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.html | 6 ++++++ src/main.cpp | 6 +++--- 4 files changed, 64 insertions(+), 5 deletions(-) create mode 100755 docs/index.html diff --git a/.gitignore b/.gitignore index 0249ca4..3592afd 100644 --- a/.gitignore +++ b/.gitignore @@ -4,9 +4,11 @@ release/ x64/ .vscode/ *.autosave +src/precompiled.h.cpp .qmake.stash zcash-qt-wallet -zcash-qt-wallet.pro.user +zcash-qt-wallet.* Makefile +Makefile.* qrc_application.cpp -zcash-qt-wallet_plugin_import.cpp \ No newline at end of file +zcash-qt-wallet_plugin_import.cpp diff --git a/README.md b/README.md index e69de29..7569ce5 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,51 @@ +zcash-qt-wallet is a z-Addr first wallet UI frontend for zcashd + +# Installation + +zcash-qt-wallet needs a zcash node running zcashd. Download the zcash node software from https://z.cash/download/ and start zcashd. + +## Prerequisites: zcashd +zcashd needs to run with RPC enabled and with a RPC username/password set. Add the following entries into ~/.zcash/zcash.conf + +``` +rpcuser=username +rpcpassword=password +``` +and restart zcashd + +## Installing zcash-qt-wallet +Head over to the releases page and grab the latest binary. Unzip and run the binary + + +### Note on running on Windows +Although zcashd is not technically supported on Windows, you can run it inside WSL (Windows Subsystem for Linux). +Configure zcash inside WSL by setting the rpcuser/rpcpassword in ~/.zcash/zcash.conf. You can +then download the Windows build and connect to the local node inside WSL, after configuring the RPC username/password +in File->Settings. + +## Compiling from source +zcash-qt-wallet depends on QT5, which you can get from here: https://www.qt.io/download + +### Compiling on Linux + +``` +git clone https://github.com/adityapk00/zcash-qt-wallet.git +cd zcash-qt-wallet +/path/to/qt5/bin/qmake zcash-qt-wallet.pro CONFIG+=DEBUG +make -j$(nproc) +``` + +## Troubleshooting FAQ +### 1. "Connection Error" + +Normally, zcash-qt-wallet can pick up the rpcuser/rpcpassword from zcash.conf. If it doesn't for some reason, you can set the username/password in the File->Settings menu. +If you are connecting to a remote node, make sure that zcashd on the remote machine is accepting connections from your machine. The target machine's firewall needs to allow connections +from your host and also zcashd is set to be configured to accept connections from this host. + +The easiest way to connect to a remote node is probably to ssh to it with port forwarding like this: +``` +ssh -L8232:127.0.0.1:8232 user@remotehost +``` +### 2. "Not enough balance" when sending transactions +The most likely cause for this is that you are trying to spend unconfirmed funds. Unlike bitcoin, the zcash protocol doesn't let you spent unconfirmed funds yet. Please wait for +1-2 blocks for the funds to confirm and retry the transaction. diff --git a/docs/index.html b/docs/index.html new file mode 100755 index 0000000..a82f076 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,6 @@ + + + +Hello World + + \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp index 5ff9e64..289ca8e 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -3,6 +3,9 @@ int main(int argc, char *argv[]) { + QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps); + QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + QApplication a(argc, argv); #ifdef Q_OS_LINUX @@ -10,9 +13,6 @@ int main(int argc, char *argv[]) qApp->setFont(QFont("Ubuntu", 11, QFont::Normal, false)); #endif - QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps); - QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); - QCoreApplication::setOrganizationName("adityapk"); QCoreApplication::setOrganizationDomain("adityapk.com"); QCoreApplication::setApplicationName("zcash-qt-wallet");