Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adityapk00 committed Mar 14, 2019
1 parent 09e39cf commit 7dc1d1b
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
@@ -1,4 +1,4 @@
zec-qt-wallet is a z-Addr first, Sapling compatible wallet and full node for zcashd that runs on Linux, Windows and macOS.
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)
Expand All @@ -10,33 +10,33 @@ Head over to the releases page and grab the latest installers or binary. https:/

If you are on Debian/Ubuntu, please download the `.deb` package and install it.
```
sudo dpkg -i linux-deb-zec-qt-wallet-v0.6.1.deb
sudo dpkg -i linux-deb-zecwallet-v0.6.1.deb
sudo apt install -f
```

Or you can download and run the binaries directly.
```
tar -xvf zec-qt-wallet-v0.6.1.tar.gz
./zec-qt-wallet-v0.6.1/zec-qt-wallet
tar -xvf zecwallet-v0.6.1.tar.gz
./zecwallet-v0.6.1/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 zec-qt-wallet to start.
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 zec-qt-wallet on to the Applications link to install.
Double-click on the .dmg file to open it, and drag zecwallet on to the Applications link to install.

## zcashd
zec-qt-wallet needs a Zcash node running zcashd. If you already have a zcashd node running, zec-qt-wallet will connect to it.
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, zec-qt-wallet will start its embedded zcashd node.
If you don't have one, ZecWallet will start its embedded zcashd node.

Additionally, if this is the first time you're running zec-qt-wallet or a zcashd daemon, zec-qt-wallet will download the zcash params (~1.7 GB) and configure `zcash.conf` for you.
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 zec-qt-wallet to connect to an external node.
Pass `--no-embedded` to disable the embedded zcashd and force ZecWallet to connect to an external node.

## Compiling from source
zec-qt-wallet 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.
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/zec-qt-wallet/wiki/Compiling-from-source-code)

Expand All @@ -48,7 +48,7 @@ cd zec-qt-wallet
/path/to/qt5/bin/qmake zec-qt-wallet.pro CONFIG+=debug
make -j$(nproc)
./zec-qt-wallet
./zecwallet
```

### Building on Windows
Expand All @@ -61,7 +61,7 @@ cd zec-qt-wallet
c:\Qt5\bin\qmake.exe zec-qt-wallet.pro -spec win32-msvc CONFIG+=debug
nmake
debug\zec-qt-wallet.exe
debug\zecwallet.exe
```

To create the Visual Studio project files so you can compile and run from Visual Studio:
Expand All @@ -78,11 +78,11 @@ cd zec-qt-wallet
/path/to/qt5/bin/qmake zec-qt-wallet.pro CONFIG+=debug
make
./zec-qt-wallet.app/Contents/MacOS/zec-qt-wallet
./zecwallet.app/Contents/MacOS/zecwallet
```

### [Troubleshooting Guide & FAQ](https://github.com/ZcashFoundation/zec-qt-wallet/wiki/Troubleshooting-&-FAQ)
Please read the [troubleshooting guide](https://github.com/ZcashFoundation/zec-qt-wallet/wiki/Troubleshooting-&-FAQ) for common problems and solutions.
For support or other questions, tweet at [@zecqtwallet](https://twitter.com/zecqtwallet) or [file an issue](https://github.com/ZcashFoundation/zec-qt-wallet/issues).
For support or other questions, tweet at [@zecwallet](https://twitter.com/zecqtwallet) or [file an issue](https://github.com/ZcashFoundation/zec-qt-wallet/issues).

_PS: zec-qt-wallet is NOT an official wallet, and is not affiliated with the Zerocoin Electric Coin Company in any way._
_PS: ZecWallet is NOT an official wallet, and is not affiliated with the Zerocoin Electric Coin Company in any way._

0 comments on commit 7dc1d1b

Please sign in to comment.