lbry-desktop/README.md

34 lines
914 B
Markdown
Raw Normal View History

2017-01-16 20:06:53 +01:00
# LBRY Electron
An electron version of the LBRY application.
2017-01-18 17:32:01 +01:00
This repo uses submodules, so clone it using --recursive
2017-01-16 20:06:53 +01:00
## Setup
2017-02-09 23:07:16 +01:00
The lbrynet library needs to be installed along with pyinstaller, and you
2017-01-16 20:06:53 +01:00
need everything to be able to build the lbry-web-ui
## Build
run `./build.sh` to create a lbry executable, bundle the front-end and move
2017-02-09 23:07:16 +01:00
everything into the `app` folder
2017-01-16 20:06:53 +01:00
## Run
2017-02-09 23:07:16 +01:00
`./node_modules/.bin/electron app`
2017-01-16 20:06:53 +01:00
## Package
To build a distributable package for OSX, run (on an OSX machine):
`electron-packager --electron-version=1.4.14 --overwrite electron LBRY`
This also probably works for windows and linux, but I haven't tested it
## TODO
This app works by launching the lbrynet daemon in a seperate process. Currently the
process management is very poor and the lbrynet process might not be shut-down when the app
is closed. Also, if the lbrynet daemon dies, there is no attempt to restart it.