lbry-desktop/README.md

# LBRY App

This is a graphical browser for the decentralized content marketplace provided by the [LBRY](https://lbry.io) protocol. It is essentially the [lbry daemon](https://github.com/lbryio/lbry) bundled with the [lbry web ui](https://github.com/lbryio/lbry-web-ui) in an [Electron](http://electron.atom.io/) application.

## 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`.

### Setup

The
[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.

### Build

run `./build.sh`

This builds the UI assets and puts them into `app/dist`. It also builds `app/dist/lbrynet-daemon`.

### Run

`./node_modules/.bin/electron app`

### Package

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.
update readme 2017-02-20 21:50:06 +01:00			`# LBRY App`
initial electron app 2017-01-16 20:06:53 +01:00
better intro 2017-02-21 19:12:21 +01:00			`This is a graphical browser for the decentralized content marketplace provided by the [LBRY](https://lbry.io) protocol. It is essentially the [lbry daemon](https://github.com/lbryio/lbry) bundled with the [lbry web ui](https://github.com/lbryio/lbry-web-ui) in an [Electron](http://electron.atom.io/) application.`
initial electron app 2017-01-16 20:06:53 +01:00
minor readme changes 2017-02-21 19:10:20 +01:00			`## Installing`
better startup and process management 2017-01-18 17:32:01 +01:00
minor readme changes 2017-02-21 19:10:20 +01:00			`Check out the [release page](https://github.com/lbryio/lbry-app/releases/latest) to download a binary.`
initial electron app 2017-01-16 20:06:53 +01:00
minor readme changes 2017-02-21 19:10:20 +01:00			`To install from source or make changes to the application, continue reading below.`
initial electron app 2017-01-16 20:06:53 +01:00
minor readme changes 2017-02-21 19:10:20 +01:00			`## Development`
initial electron app 2017-01-16 20:06:53 +01:00
minor readme changes 2017-02-21 19:10:20 +01:00			This repo uses submodules, so clone it using `--recursive`.
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`### Setup`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`The`
minor readme changes 2017-02-21 19:10:20 +01:00			`[lbry daemon](https://github.com/lbryio/lbry/blob/master/INSTALL.md) needs`
update readme 2017-02-20 21:50:06 +01:00			`to be installed along with pyinstaller. You also need to be`
			`able to build the lbry-web-ui, so have node, webpack, etc installed.`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`### Build`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			run `./build.sh`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			This builds the UI assets and puts them into `app/dist`. It also builds `app/dist/lbrynet-daemon`.

			`### Run`

			`./node_modules/.bin/electron app`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`### Package`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`We use [electron-builder](https://github.com/electron-userland/electron-builder)`
			`to create distributable packages, which is run by calling:`
initial electron app 2017-01-16 20:06:53 +01:00
update readme 2017-02-20 21:50:06 +01:00			`node_modules/.bin/build -p never`
minor readme changes 2017-02-21 19:10:20 +01:00
			`### 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.`