Browse Source

Update README.md

pull/19/head
adityapk00 5 years ago
committed by GitHub
parent
commit
3952ded930
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 82
      README.md

82
README.md

@ -1,88 +1,20 @@
ZecWallet is a z-Addr first, Sapling compatible wallet and full node for zcashd that runs on Linux, Windows and macOS.
![Screenshot](docs/screenshot-main.png?raw=true)
![Screenshots](docs/screenshot-sub.png?raw=true)
# Installation
Head over to the releases page and grab the latest installers or binary. https://github.com/ZcashFoundation/zecwallet/releases
### Linux
If you are on Debian/Ubuntu, please download the `.deb` package and install it.
```
sudo dpkg -i linux-deb-zecwallet-v0.7.9.deb
sudo apt install -f
```
Or you can download and run the binaries directly.
```
tar -xvf zecwallet-v0.7.9.tar.gz
./zecwallet-v0.7.9/zecwallet
```
### Windows
Download and run the `.msi` installer and follow the prompts. Alternately, you can download the release binary, unzip it and double click on `zecwallet.exe` to start.
### macOS
Double-click on the `.dmg` file to open it, and drag `zecwallet` on to the Applications link to install.
## zcashd
ZecWallet needs a Zcash node running zcashd. If you already have a zcashd node running, ZecWallet will connect to it.
If you don't have one, ZecWallet will start its embedded zcashd node.
Additionally, if this is the first time you're running ZecWallet or a zcashd daemon, ZecWallet will download the zcash params (~1.7 GB) and configure `zcash.conf` for you.
Pass `--no-embedded` to disable the embedded zcashd and force ZecWallet to connect to an external node.
ZecWallet-lite is z-Addr first, Sapling compatible wallet lightwallet for Zcash
## Compiling from source
ZecWallet 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). Note that if you are compiling from source, you won't get the embedded zcashd by default. You can either run an external zcashd, or compile zcashd as well.
See detailed build instructions [on the wiki](https://github.com/ZcashFoundation/zecwallet/wiki/Compiling-from-source-code)
* ZecWallet 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.37 +
### Building on Linux
```
git clone https://github.com/ZcashFoundation/zecwallet.git
git clone https://github.com/adityapk/zecwallet-lite.git
cd zecwallet
/path/to/qt5/bin/qmake zec-qt-wallet.pro CONFIG+=debug
/path/to/qt5/bin/qmake zecwallet-lite.pro CONFIG+=debug
make -j$(nproc)
./zecwallet
```
### Building on Windows
You need Visual Studio 2017 (The free C++ Community Edition works just fine).
From the VS Tools command prompt
```
git clone https://github.com/ZcashFoundation/zecwallet.git
cd zecwallet
c:\Qt5\bin\qmake.exe zec-qt-wallet.pro -spec win32-msvc CONFIG+=debug
nmake
debug\zecwallet.exe
```
To create the Visual Studio project files so you can compile and run from Visual Studio:
```
c:\Qt5\bin\qmake.exe zec-qt-wallet.pro -tp vc CONFIG+=debug
```
### Building on macOS
You need to install the Xcode app or the Xcode command line tools first, and then install Qt.
```
git clone https://github.com/ZcashFoundation/zecwallet.git
cd zecwallet
/path/to/qt5/bin/qmake zec-qt-wallet.pro CONFIG+=debug
make
./zecwallet.app/Contents/MacOS/zecwallet
```
### [Troubleshooting Guide & FAQ](https://github.com/ZcashFoundation/zecwallet/wiki/Troubleshooting-&-FAQ)
Please read the [troubleshooting guide](https://docs.zecwallet.co/troubleshooting/) for common problems and solutions.
For support or other questions, tweet at [@zecwallet](https://twitter.com/zecwallet) or [file an issue](https://github.com/ZcashFoundation/zecwallet/issues).
Right now, you'll also need to run `lightwalletd` on your local machine for Zecwallet to connect to.
_PS: ZecWallet is NOT an official wallet, and is not affiliated with the Electric Coin Company in any way._

Loading…
Cancel
Save