Merge pull request #2 from teran-mckinney/master

Markdown cleanups

INSTALL.md

@@ -8,7 +8,9 @@ built into LBRYnet.
 
 on Ubuntu:
 
+```
 sudo apt-get install libgmp3-dev build-essential python-dev python-pip
+```
 
 Getting the source
 ------------------
@@ -20,15 +22,19 @@ Setting up the environment
 
 It's recommended that you use a virtualenv
 
+```
 sudo apt-get install python-virtualenv
 cd <source base directory>
 virtualenv .
 source bin/activate
+```
 
 (to deactivate the virtualenv, enter 'deactivate')
 
+```
 python setup.py install
+```
 
 this will install all of the libraries and a few applications
 
-For running the file sharing application, see RUNNING
+For running the file sharing application, see [RUNNING](RUNNING.md)

README.md

@@ -28,11 +28,11 @@ must first obtain the 'stream descriptor' and then may open it with his 'lbrynet
 download all of the chunks by locating peers with the chunks via the DHT, and then combine the
 chunks into the original file, according to the metadata included in the 'stream descriptor'.
 
-To install and use this client, see INSTALL and RUNNING
+To install and use this client, see [INSTALL](INSTALL.md) and [RUNNING](RUNNING.md)
 
 ## Installation
 
-See INSTALL
+See [INSTALL](INSTALL.md)
 
 ## Developers
 
@@ -47,4 +47,4 @@ Send all support requests to jimmy@lbry.io
 
 ## License
 
-See LICENSE
+See [LICENSE](LICENSE.md)

RUNNING.md

@@ -8,59 +8,55 @@ Download the file https://raw.githubusercontent.com/lbryio/lbry-setup/master/lbr
 
 Once it's done building, type:
 
+```
 ./lbrycrd/src/lbrycrdd -server -daemon
-
 lbrynet-gui
+```
 
 A window should show up with an entry box
 
 Type wonderfullife into the box, hit go, and choose to stream or save
 
-To stop lbrycrdd:
+To stop lbrycrdd: `./lbrycrd/src/lbrycrd-cli stop`
 
-./lbrycrd/src/lbrycrd-cli stop
 
 ## Slightly longer install guide
 
 ### Installing lbrycrd from source
 
-Acquire the LBRYcrd source code from https://github.com/lbryio/lbrycrd
+```
-
+git clone --depth=1 https://github.com/lbryio/lbrycrd.git
 cd lbrycrd
-
 sudo apt-get install build-essential libtool autotools-dev autoconf pkg-config libssl-dev libboost-all-dev libdb-dev libdb++-dev libqt4-dev libprotobuf-dev protobuf-compiler
-
 ./autogen.sh
-
+./configure --with-incompatible-bdb --without-gui
-./configure --with-incompatible-bdb
 
 make
+```
 
 When make has completed, create the directory where LBRYcrd data will be stored. ~/.lbrycrd is where LBRYcrd will look by default and so is recommended.
 
+```
 mkdir ~/.lbrycrd
-
+echo 'rpcuser=rpcuser
-vim ~/.lbrycrd/lbrycrd.conf
+rpcpassword=rpcpassword' > ~/.lbrycrd/lbrycrd.conf
-
+# (use a long random password if your computer is on a network anyone else has access to. e.g, pwgen -s 20)
-Add the following lines to enable the RPC interface, which will be used by lbrynet-console.
-
-rpcuser=rpcuser
-
-rpcpassword=rpcpassword
-
-(use a long random password if your computer is on a network anyone else has access to)
-
 cd ..
 
+```
+
 ### Installing lbrynet from source
 
 Acquire the LBRYnet source code from https://github.com/lbryio/lbry
 
+```
 cd lbry
 sudo apt-get install libgmp3-dev build-essential python-dev python-pip
+```
 
 (with virtualenv)
 
+```
 python-virtualenv
 
 virtualenv .
@@ -69,33 +65,45 @@ source bin/activate
 
 python setup.py install
 
+```
+
 to deactivate the virtualenv later:
 
+```
 deactivate
+```
 
 to reactivate it, go to the directory in which you created it and:
 
+```
 source bin/activate
+```
 
 (without virtualenv)
 
+```
 python setup.py build bdist_egg
 
 sudo python setup.py install
+```
 
 ## Slightly longer running guide
 
-In order to use lbrynet-console or lbrynet-gui, lbyrcrdd must be running.
+###In order to use lbrynet-console or lbrynet-gui, lbyrcrd must be running.
 
 ### Running lbrycrd
 
 If you ran the easy install script, the lbrycrd folder will be in the directory you ran lbry_setup.sh from. Otherwise it is the root of the cloned lbrycrd repository. Go to that directory.
 
+```
 ./src/lbrycrdd -server -daemon
+```
 
 If you want to mine LBC, also use the flag '-gen', so:
 
+```
 ./src/lbrycrdd -server -daemon -gen
+```
 
 It will take a few minutes for your client to download the whole block chain.
 
@@ -103,35 +111,31 @@ lbrycrdd must be running in order for lbrynet to function.
 
 To shut lbrycrdd down: from the lbrycrd directory, run
 
- ./src/lbrycrd-cli stop
+```
+./src/lbrycrd-cli stop
+```
 
 ### Option 1) Running lbrynet-console
 
 If you used the virtualenv instructions above, make sure the virtualenv is still active. If not, reactivate it according to the instructions above, under "Installing lbrynet from source"
 
-In your terminal:
+In your terminal: `lbrynet-console`
-
-lbrynet-console
 
 You should be presented with a prompt.
 
 Watch It's a Wonderful Life via LBRY
 
-Type into the prompt:
+Type into the prompt: `get wonderfullife`
 
-get wonderfullife
+To shut it down, press ctrl-c at any time or enter `exit` into the prompt.
-
-To shut it down, type ctrl-c at any time or enter 'exit' into the prompt.
 
 ### Option 2) Running lbrynet-gui
 
 If you used the virtualenv instructions above, make sure the virtualenv is still active. If not, reactivate it according to the instructions above, under "Installing lbrynet from source"
 
-In your terminal:
+In your terminal: `lbrynet-gui`
 
-lbrynet-gui
+A window should pop up with an entry box. Type `wonderfullife` into the box, hit go, and then choose to save it or stream it.
-
-A window should pop up with an entry box. Type 'wonderfullife' into the box, hit go, and then choose to save it or stream it.
 Enjoy!
 
 Any questions or problems, email jimmy@lbry.io