minor readme changes

This commit is contained in:
Jeremy Kauffman 2017-02-21 13:10:20 -05:00 committed by GitHub
parent 5d55af0a77
commit 4a68835bba

View file

@ -1,22 +1,21 @@
# LBRY App
A decentralized content marketplace built on top of the [lbry protocol](https://github.com/lbryio/lbry)
This is a graphical browser for the decentralized content marketplace provided by the [lbry protocol](https://github.com/lbryio/lbry).
Check out the [release page](https://github.com/lbryio/lbry-app/releases/latest) to get started.
## Installing
Check out the [release page](https://github.com/lbryio/lbry-app/releases/latest) to download a binary.
To install from source or make changes to the application, continue reading below.
## Development
This repo uses submodules, so clone it using --recursive
We do most of our development work on linux and macOS so we don't have
any instructions for creating a development setup on windows. You can
checkout out the build steps in [appveyor.yml](https://github.com/lbryio/lbry-app/blob/master/appveyor.yml) and probably figure out something from there.
This repo uses submodules, so clone it using `--recursive`.
### Setup
The
[lbrynet library](https://github.com/lbryio/lbry/blob/master/INSTALL.md) needs
[lbry daemon](https://github.com/lbryio/lbry/blob/master/INSTALL.md) needs
to be installed along with pyinstaller. You also need to be
able to build the lbry-web-ui, so have node, webpack, etc installed.
@ -36,3 +35,8 @@ We use [electron-builder](https://github.com/electron-userland/electron-builder)
to create distributable packages, which is run by calling:
`node_modules/.bin/build -p never`
### Development on Windows
This project has currently only been worked on in Linux and macOS. If you are on Windows, you can
checkout out the build steps in [appveyor.yml](https://github.com/lbryio/lbry-app/blob/master/appveyor.yml) and probably figure out something from there.