update README
This commit is contained in:
parent
c115e9c923
commit
8bdcaa75c8
1 changed files with 12 additions and 14 deletions
26
README.md
26
README.md
|
@ -18,26 +18,24 @@ To install from source or make changes to the application, continue reading belo
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
This repo uses submodules, so clone it using `--recursive`.
|
### One-time Setup
|
||||||
|
|
||||||
### Setup
|
1. Install node and npm.
|
||||||
|
2. Check out this repo.
|
||||||
|
3. Set up a Python virtual environment, or live on the wild side.
|
||||||
|
4. Run `./build.sh`. This builds the UI assets and puts them into `app/dist`. It also downloads [lbry daemon](https://github.com/lbryio/lbry/releases).
|
||||||
|
|
||||||
The
|
### Running
|
||||||
[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 `./node_modules/.bin/electron app`
|
||||||
|
|
||||||
run `./build.sh`
|
### Ongoing Development
|
||||||
|
1. `cd ui`
|
||||||
|
2. `./watch.sh`
|
||||||
|
|
||||||
This builds the UI assets and puts them into `app/dist`. It also builds `app/dist/lbrynet-daemon`.
|
This will set up a monitor that will automatically monitor and compile any changes to JS or CSS folders inside of the `ui` folder. This allows you to make changes and see them immediately by reloading the app.
|
||||||
|
|
||||||
### Run
|
### Packaging
|
||||||
|
|
||||||
`./node_modules/.bin/electron app`
|
|
||||||
|
|
||||||
### Package
|
|
||||||
|
|
||||||
We use [electron-builder](https://github.com/electron-userland/electron-builder)
|
We use [electron-builder](https://github.com/electron-userland/electron-builder)
|
||||||
to create distributable packages, which is run by calling:
|
to create distributable packages, which is run by calling:
|
||||||
|
|
Loading…
Reference in a new issue