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

Readme fixes (#192)

Browse source 
* Update README.md

* Update README.md

* Update --say-thank-you.md
This commit is contained in:
Florence Jay Munar 2021-11-01 21:54:35 +08:00 committed by GitHub
parent 56b800cd33
commit 994a39b0df
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
.github/ISSUE_TEMPLATE/--say-thank-you.md vendored
View file

@ -1,22 +1,22 @@
--- ---
name: "❤️Say thank you" name: "❤️Say thank you"
about: If you enjoy using the LBRY app, let us know! about: If you enjoy using Odysee's website, let us know!
title: LBRY rocks! title: Odysee rocks!
labels: '' labels: ''
assignees: '' assignees: ''
--- ---
If you are using the LBRY app - please let us know. We'd love to hear from you! If you are using the Odysee's website - please let us know. We'd love to hear from you!
If you would like to help Nock - any of the following is greatly appreciated. If you would like to help Nock - any of the following is greatly appreciated.
- Give the repository a star ⭐️ - Give the repository a star ⭐️
- Help out with issues - Help out with issues
- Blog about LBRY - Blog about Odysee
- Make tutorials - Make tutorials
- Give talks - Give talks
- Convince other people to use LBRY - Convince other people to use Odysee
- Anything your heart desires - Anything your heart desires
Thank you! 💐 Thank you! 💐

61
README.md
View file

@ -28,40 +28,12 @@ This repo contains the UI and front end code that powers Odysee.com.
## Table of Contents ## Table of Contents
1. [Install](#install) 1. [Usage](#usage)
2. [Usage](#usage) 2. [Running from Source](#running-from-source)
3. [Running from Source](#running-from-source) 3. [Contributing](#contributing)
4. [Contributing](#contributing) 4. [License](#license)
5. [License](#license) 5. [Security](#security)
6. [Security](#security) 6. [Contact](#contact)
7. [Contact](#contact)
## Install
[![Windows](https://img.shields.io/badge/Windows-Install-blue)](https://lbry.com/get/lbry.exe)
[![Linux](https://img.shields.io/badge/Linux-Install-blue)](https://lbry.com/get/lbry.deb)
[![MacOS](https://img.shields.io/badge/MacOS-Install-blue)](https://lbry.com/get/lbry.dmg)
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
| | Windows | macOS | Linux |
| --------------------- | --------------------------------------------- | --------------------------------------------- | --------------------------------------------- |
| Latest Stable Release | [Download](https://lbry.com/get/lbry.exe) | [Download](https://lbry.com/get/lbry.dmg) | [Download](https://lbry.com/get/lbry.deb) |
| Latest Pre-release | [Download](https://lbry.com/get/lbry.pre.exe) | [Download](https://lbry.com/get/lbry.pre.dmg) | [Download](https://lbry.com/get/lbry.pre.deb) |
Our [releases page](https://github.com/lbryio/lbry-desktop/releases) also contains the latest
release, pre-releases, and past builds.
_Note: If the deb fails to install using the Ubuntu Software Center, install manually via `sudo dpkg -i <path to deb>`. You'll need to run `sudo apt-get install -f` if this is the first time installing it to install dependencies_
To install from source or make changes to the application, continue to the next section below.
**Community maintained** builds for Arch Linux and Flatpak are available, see below. These installs will need to be updated manually as the in-app update process only supports Debian installs at this time.
_Note: If coming from a deb install, the directory structure is different and you'll need to [migrate data](https://lbry.com/faq/backup-data)._
| | Flatpak | Arch | Nixpkgs | ARM/ARM64 |
| -------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------- |
| Latest Release | [FlatHub Page](https://flathub.org/apps/details/io.lbry.lbry-app) | [AUR Package](https://aur.archlinux.org/packages/lbry-app-bin/) | [Nixpkgs](https://search.nixos.org/packages?channel=unstable&show=lbry&query=lbry) | [Build Guide](https://lbry.tv/@LBRYarm:5) |
| Maintainers | [@kcSeb](https://keybase.io/kcseb) | [@kcSeb](https://keybase.io/kcseb) | [@Enderger](https://github.com/enderger) | [@Madiator2011](https://github.com/kodxana) |
## Usage ## Usage
@ -81,12 +53,6 @@ You can run the web version (lbry.tv), the electron app, or both at the same tim
2. Change directory into the cloned repository: `cd lbry-desktop` 2. Change directory into the cloned repository: `cd lbry-desktop`
3. Install the dependencies: `yarn` 3. Install the dependencies: `yarn`
#### Run the electron app
`yarn dev`
- If you want to build and launch the production app you can run `yarn build`. This will give you an executable inside the `/dist` folder. We use [electron-builder](https://github.com/electron-userland/electron-builder) to create distributable packages.
#### Run the web app for development #### Run the web app for development
`yarn dev:web` `yarn dev:web`
@ -136,17 +102,6 @@ PINNED_LABEL_2=OtherLinkText
6. Run `NODE_ENV=production yarn compile:web` to build 6. Run `NODE_ENV=production yarn compile:web` to build
7. Set up pm2 to start ./web/index.js 7. Set up pm2 to start ./web/index.js
#### Run both at the same time
Run the two commands above in separate terminal windows
```
yarn dev
// in another terminal window
yarn dev:web
```
#### Resetting your Packages #### Resetting your Packages
If the app isn't building, or `yarn xxx` commands aren't working you may need to just reset your `node_modules`. To do so you can run: `rm -r node_modules && yarn` or `del /s /q node_modules && yarn` on Windows. If the app isn't building, or `yarn xxx` commands aren't working you may need to just reset your `node_modules`. To do so you can run: `rm -r node_modules && yarn` or `del /s /q node_modules && yarn` on Windows.
@ -155,9 +110,9 @@ If you _really_ think something might have gone wrong, you can force your repo t
## Contributing ## Contributing
We :heart: contributions from everyone and contributions to this project are encouraged, and compensated. We welcome [bug reports](https://github.com/lbryio/lbry-desktop/issues/), [bug fixes](https://github.com/lbryio/lbry-desktop/pulls) and feedback is always appreciated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md). We :heart: contributions from everyone and contributions to this project are encouraged, and compensated. We welcome [bug reports](https://github.com/OdyseeTeam/odysee-frontend/issues/), [bug fixes](https://github.com/OdyseeTeam/odysee-frontend/pulls) and feedback is always appreciated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
## [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lbryio/lbry-desktop/issues) [![GitHub contributors](https://img.shields.io/github/contributors/lbryio/lbry-desktop.svg)](https://GitHub.com/lbryio/lbry-desktop/graphs/contributors/) ## [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/OdyseeTeam/odysee-frontend/issues) [![GitHub contributors](https://img.shields.io/github/contributors/lbryio/lbry-desktop.svg)](https://GitHub.com/OdyseeTeam/odysee-frontend/graphs/contributors/)
## License ## License