LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

Update docs

Browse source
This commit is contained in:
Igor Gassmann 2017-12-07 12:40:49 -03:00
parent eaa5c212d2
commit 5ade6fba41
2 changed files with 11 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -27,21 +27,17 @@ To install from source or make changes to the application, continue reading belo
This will download and install the LBRY app and its dependencies, including [the LBRY daemon](https://github.com/lbryio/lbry) and command line utilities like `node` and `yarn`. The LBRY app requires Node >= 6; if you have an earlier version of Node installed and want to keep it, you can use [nvm](https://github.com/creationix/nvm) to switch back and forth.
### Running
Run `./node_modules/.bin/electron .`
### Ongoing Development
`./watch.sh`
Run `yarn dev`
This will set up a monitor that will automatically compile any changes to JS or CSS folders inside of the `src/renderer` folder. This allows you to make changes and see them immediately by reloading the app.
This will set up a server that will automatically compile any changes made inside `src\` folder and automatically reload the app without loosing the state.
### Packaging
We use [electron-builder](https://github.com/electron-userland/electron-builder)
to create distributable packages, which is run by calling:
Run `yarn dist`
`node_modules/.bin/build -p never`
We use [electron-builder](https://github.com/electron-userland/electron-builder)
to create distributable packages.
## Development on Windows
@ -64,24 +60,18 @@ exit
python -m pip install -r build\requirements.txt
npm install -g yarn
yarn install
npm rebuild node-sass
node_modules\.bin\node-sass --output dist\css --sourcemap=none src\renderer\scss\
node_modules\.bin\webpack --config src\renderer\webpack.prod.js
xcopy /E src\renderer\dist dist
yarn dist
```
3. Download the lbry daemon and cli [binaries](https://github.com/lbryio/lbry/releases) and place them in `dist\`
### Building lbry-app
Run `node_modules\.bin\build -p never` from the root of the project.
### Running the electron app
Run `node_modules\.bin\electron .`
Run `yarn dist`
### Ongoing Development
Run `watch.bat`
Run `yarn dev`
This will set up a monitor that will automatically compile any changes to JS or CSS folders inside of the `src\renderer` folder. This allows you to make changes and see them immediately by reloading the app.
This will set up a server that will automatically compile any changes made inside `src\` folder and automatically reload the app without loosing the state.
## Internationalization
If you want to help translating the lbry-app, you can copy the en.json file in /src/main/locales and modify the values while leaving the keys as their original English strings. An example for this would be: `"Skip": "Überspringen",` Translations should automatically show up in options.
If you want to help translating the lbry-app, you can copy the `en.json` file in `/dist/locales/` and modify the values while leaving the keys as their original English strings. An example for this would be: `"Skip": "Überspringen",` Translations should automatically show up in options.

2
build/build.sh
View file

@ -98,5 +98,5 @@ if [ "$FULL_BUILD" == "true" ]; then
echo -e '\033[0;32mBuild and packaging complete.\x1b[m'
else
echo -e 'Build complete. Run \033[1;31m./node_modules/.bin/electron .\x1b[m to launch the app'
echo -e 'Build complete. Run \033[1;31myarn dev\x1b[m to launch the app'
fi