LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

improvements to readme and install instructions (#396)

Browse source 
* improvements to readme and install instructions

* Update README.md

* Update INSTALL.md
This commit is contained in:
Jeremy Kauffman 2017-01-09 18:01:50 -05:00 committed by Alex Grin
parent c393bd97e8
commit fd5b4f403a
2 changed files with 61 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
INSTALL.md
View file

@ -1,26 +1,18 @@
#### Installing the LBRY app
--------------------------
# Installing LBRY
Installing LBRY is simple. You can get a dmg installer for OS X or a .deb for linux [here](https://github.com/lbryio/lbry/releases/latest).
The recommended way to install LBRY is to use an installer. We provide installers for all major operating systems. See the [README](README).
##### OS X
Drag and drop LBRY.app into your applications folder (replacing any older versions). When it's running you'll have a LBRY icon in your status bar and the browser will open to the UI.
These instructions are for installing from source code, which is recommended if you are interested in doing development work or LBRY is not available on your operating system (good luck, TempleOS users).
##### Linux
Double click the .deb file and follow the prompts. The app can be started by searching "LBRY", and it can be turned off by clicking the red 'x' in the browser interface.
## Prerequisites
On both systems you can also open the UI while the app is running by going to lbry://lbry in Firefox or Safari, or localhost:5279 in Chrome.
Before starting, you'll need to install some additional libraries depending on your operating system.
### OS X Prerequisites
#### Installing LBRY from source
--------------------------
Install [xcode command line tools](https://developer.xamarin.com/guides/testcloud/calabash/configuring/osx/install-xcode-command-line-tools/) and [homebrew](http://brew.sh/).
Installing LBRY from source is not the recommended way to install
LBRY. Only do so if you're interested in doing development work.
##### OS X Prerequisites
In order to install LBRY from source you'll need to first install [xcode command line tools](https://developer.xamarin.com/guides/testcloud/calabash/configuring/osx/install-xcode-command-line-tools/) and [homebrew](http://brew.sh/). The dependencies can then be installed by running
Remaining dependencies can then be installed by running:
```
brew install mpfr libmpc
@ -28,48 +20,31 @@ sudo easy_install pip
sudo pip install virtualenv
```
##### Linux Prerequisites
On Ubuntu or Mint you can install the prerequisites by running
### Linux Prerequisites
```
sudo apt-get install libgmp3-dev build-essential python2.7 python2.7-dev \
On Ubuntu (we recommend 16.04), install the following:
```
sudo apt-get install libgmp3-dev build-essential python2.7 python2.7-dev \
python-pip git python-virtualenv libssl-dev libffi-dev
```
```
##### OSX and Linux Installation
If you're running another Linux flavor, install the equivalent of the above packages for your system.
It is strongly recommended to create a new virtualenv for LBRY
```
virtualenv lbry-venv
source lbry-venv/bin/activate
```
and install the package in the new virtualenv:
```
git clone https://github.com/lbryio/lbry.git
cd lbry
pip install -r requirements.txt
pip install .
```
To start LBRY, run `lbrynet-daemon` in a terminal.
##### On windows
### Windows Prerequisites
Install [mingw32](http://www.mingw.org/) base and c++ compiler.
Add C:\MinGW\bin to the windows PATH.
Enable distutils to compile with mingw32 by creating a distutils.cfg file in *PYTHONPATH\Lib\distutils* containing
Enable distutils to compile with mingw32 by creating a distutils.cfg file in *PYTHONPATH\Lib\distutils* containing:
```
[build]
compiler = mingw32
```
If using virtualenv, copy the *PYTHONPATH\Lib\distutils* directory to the virtualenv.
If using virtualenv, which is recommended, copy the *PYTHONPATH\Lib\distutils* directory to the virtualenv.
It's recommended to use [Unofficial Windows Binaries for Python Extension Packages](http://www.lfd.uci.edu/~gohlke/pythonlibs/) for as many of the required packages as possible.
Currently, available binaries include:
@ -86,8 +61,25 @@ Install the each of the preceding binaries with `pip install *.whl`
Install pywin32 system files by run `python.exe Scripts\pywin32_postinstall.py -install` from an elevated command prompt.
Install the rest of the required modules with the standard `pip install module` command
Finally, you'll need [miniupnpc](https://pypi.python.org/pypi/miniupnpc/1.9). Download the source and compile with MinGW by running `mingw32make.bat`.
Then, install the module by running `python setupmingw32.py install`.
The one module which requires additional work is [miniupnpc](https://pypi.python.org/pypi/miniupnpc/1.9).
Download the source and compile with MinGW by running `mingw32make.bat`
Then install the module by running `python setupmingw32.py install`
## Installation
We strongly recommend creating a new virtualenv for LBRY:
```
virtualenv lbry-venv
source lbry-venv/bin/activate
```
Then, install the package in the new virtualenv:
```
git clone https://github.com/lbryio/lbry.git
cd lbry
pip install -r requirements.txt
pip install .
```
To start LBRY, run `lbrynet-daemon` in a terminal.

32
README.md
View file

@ -1,19 +1,29 @@
[![Build Status](https://travis-ci.org/lbryio/lbry.svg?branch=master)](https://travis-ci.org/lbryio/lbry)
[![Coverage Status](https://coveralls.io/repos/github/lbryio/lbry/badge.svg)](https://coveralls.io/github/lbryio/lbry)
# LBRYnet
# LBRY
LBRYnet is a fully decentralized network for distributing data. It consists of peers uploading
LBRY is a fully decentralized, open-source protocol facilitating the discovery, access, and (sometimes) purchase of data.
## Installing LBRY
We've provided binaries for Windows, macOS, and Debian-based Linux.
| Windows | macOS | Linux |
| --- | --- | --- |
| [Download MSI](https://lbry.io/get/lbry.msi) | [Download PKG](https://lbry.io/get/lbry.pkg) | [Download DEB](https://lbry.io/get/lbry.deb) |
Our [releases page](https://github.com/lbryio/lbry/releases/latest) also contains the latest release, pre-releases, and past builds.
For instructions on building from source, see [INSTALL.md](INSTALL.md).
## What is LBRY?
LBRY is a fully decentralized network for distributing data. It consists of peers uploading
and downloading data from other peers, possibly in exchange for payments, and a distributed hash
table, used by peers to discover other peers.
## Installation
Download the [latest release](https://github.com/lbryio/lbry/releases/latest) or see [INSTALL.md](INSTALL.md) for manual installation.
## Overview
On LBRYnet, data is broken into chunks, and each chunk is specified by its sha384 hash sum. This
On LBRY, data is broken into chunks, and each chunk is specified by its sha384 hash sum. This
guarantees that peers can verify the correctness of each chunk without having to know anything
about its contents, and can confidently re-transmit the chunk to other peers. Peers wishing to
transmit chunks to other peers announce to the distributed hash table that they are associated
@ -58,13 +68,13 @@ For instructions on installing from source, see [INSTALL.md](INSTALL.md).
Source code: https://github.com/lbryio/lbry
To contribute, [join us on Slack](https://lbry-slackin.herokuapp.com/) or contact josh@lbry.io. Pull requests are also welcome.
To contribute, [join us on Slack](https://lbry-slackin.herokuapp.com/) or contact jeremy@lbry.io. Pull requests are also welcome.
## Support
Please open an issue and describe your situation in detail. We will respond as soon as we can.
For private issues, contact josh@lbry.io.
For private issues, contact jeremy@lbry.io.
## License