Browse Source

fix(update-readme): Changes based on feedback

renovate/lint-staged-8.x
helgabutters 7 years ago
parent
commit
e16be2793a
  1. 4
      ADVANCED.md
  2. 2
      CONTRIBUTING.md
  3. 32
      README.md

4
ADVANCED.md

@ -40,7 +40,9 @@ To setup `lnd` for Zap, you have two options:
### Light Client
`lnd` has a light client called `neutrino` which allows you to run `lnd` without requiring a full node. This is the default configuration for the Zap wallet. To use the light client you can either use the [Lightning Labs Binary](#lightning-labs-binary) or [Compile lnd](#compile-lnd).
`lnd` allows you to configure your node to use the new light client `neutrino` (BIP 157 & BIP 158) which allows you to run `lnd` without requiring a full node.
This is the default configuration for the Zap wallet. To use the light client you can either use the [Lightning Labs Binary](#lightning-labs-binary) or [Compile lnd](#compile-lnd).
#### Lightning Labs Binary

2
CONTRIBUTING.md

@ -2,7 +2,7 @@
(Even after a recent refactor the code is still a bit sloppy, in a bit of a segwit rush, apologize in advance for any "wtf is this?")
## Overview
Please join us on [slack](https://join.slack.com/t/zaphq/shared_invite/enQtMjkyNTAxNDA3MjE2LWE3NGZjZGE5ZmI1NGQ5YTk3MGQzMTdmNDAwYjNhZTJkMWU0ZWZlNzA0MjJiNDBjMzcxYjcyMDMxNWY3OGNhYWQ) and check [open issues](https://github.com/LN-Zap/zap-desktop/issues) to see what contributions are needed before tackling a task to avoid duplicate work.
Please join us on [slack](https://join.slack.com/t/zaphq/shared_invite/enQtMzA4OTgxNTQ4NzUzLTQwYjkzZGM0ZWMwYmYyZTE2Y2E1YjM5NTIwOTU0M2I1Zjc2YWY1NTc4NjdhZWQxNTM1YzEzOGM2YTVlNWIwODc) and check [open issues](https://github.com/LN-Zap/zap-desktop/issues) to see what contributions are needed before tackling a task to avoid duplicate work.
## Pull Requests
The `master` branch will be used for all pull requests for the time being. This may change as the repo and contributors grow.

32
README.md

@ -21,19 +21,31 @@ Download the [latest release](https://github.com/LN-Zap/zap-desktop/releases) fo
### macOS
Once you have the .dmg file downloaded, double click on the file the mount the image.
Once you have the .zip file downloaded, simply **double click** on the file to unzip.
Then drag-and-drop the `Zap.app` to `Applications`.
Then navigate to the extracted folder drag-and-drop the `Zap.app` to `Applications`.
Unmount the image and navigate to `Applications`.
Finally, open `Zap.app`
### Windows
Once you have the .exe file downloaded, simply double click on the file.
Once you have the .exe file downloaded, simply **double click** on the file.
### Linux (.deb)
### Linux
Once you have the .deb file downloaded, you will need to install the package with `dpkg`:
Once you have the .zip file downloaded, simply **double click** the file to unzip or run the following command:
```bash
unzip file.zip
```
You have the option to either install Zap through the [.deb](#.deb-file) or [.AppImage](#.appimage-file) files.
#### .deb File
Once you have the .deb file extracted, you can install Zap by **double clicking** on the file or through the `dpkg` command:
```bash
sudo dpkg -i file.deb
@ -51,15 +63,9 @@ To run Zap you can either navigate through the GUI or run the following command:
zap-desktop
```
### Linux (AppImage)
Once you have downloaded the .AppImage file, you will need to navigate to the download directory and make it executable:
```bash
chmod +x file.AppImage
```
#### .AppImage File
Then you can simply run the file:
Once you have the .AppImage file extracted, you can either **double click** the file or by running in the cli:
```bash
./file.AppImage

Loading…
Cancel
Save