From 9a24bddeadfe621de277feef469726abf2b6556f Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Sat, 21 Jan 2017 11:13:55 -0500 Subject: [PATCH 1/5] amend/clarify install instructions --- INSTALL.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 83539e5b5..9779d07e2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -66,20 +66,27 @@ Then, install the module by running `python setupmingw32.py install`. ## Installation -We strongly recommend creating a new virtualenv for LBRY: +To install: - ``` - 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 + + #the next two commands set up a virtual environment for lbry - these are optional but strongly recommended + virtualenv lbry-venv + source lbry-venv/bin/activate + pip install -r requirements.txt pip install . ``` To start LBRY, run `lbrynet-daemon` in a terminal. + +To verify your install, `which lbrynet-daemon` should return a path inside of the `lbry-venv` folder created by the `virtual-env` command. + +## Making a Change + +``` +source lbry-venv/bin/activate #this only needs to be run once, if you are not already in the virtual environment +python setup.py install #this will update lbrynet-daemon and other executables +``` From 5a467f55baf54f8f1ff4933de611b3102885085b Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Sat, 21 Jan 2017 11:17:05 -0500 Subject: [PATCH 2/5] easier to read --- INSTALL.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 9779d07e2..138d3da0f 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -72,7 +72,6 @@ To install: git clone https://github.com/lbryio/lbry.git cd lbry - #the next two commands set up a virtual environment for lbry - these are optional but strongly recommended virtualenv lbry-venv source lbry-venv/bin/activate @@ -86,7 +85,16 @@ To verify your install, `which lbrynet-daemon` should return a path inside of th ## Making a Change +If you are not already inside the virtual environment, run: + ``` -source lbry-venv/bin/activate #this only needs to be run once, if you are not already in the virtual environment -python setup.py install #this will update lbrynet-daemon and other executables +source lbry-venv/bin/activate ``` + +Then run: + +``` +python setup.py install +``` + +This will update `lbrynet-daemon` and other executables. From c71ac5b535ca5953c7323fc08e9bda91b8479615 Mon Sep 17 00:00:00 2001 From: Jeremy Kauffman Date: Sat, 21 Jan 2017 11:19:44 -0500 Subject: [PATCH 3/5] Ignore the folder we recommend to use for virtual-env in INSTALL.md --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 9395abc8e..b2f43a96a 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ /dist /lbrynet.egg-info /docs_build +/lbry-venv .idea/.name .coverage From 8fd7489d99a3e6d992f0e78f88c48a4c6b7e7930 Mon Sep 17 00:00:00 2001 From: Alex Grin Date: Tue, 24 Jan 2017 11:51:12 -0500 Subject: [PATCH 4/5] Update INSTALL.md --- INSTALL.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 138d3da0f..4d8a7832a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -57,12 +57,11 @@ Currently, available binaries include: - requests - gmpy -Install the each of the preceding binaries with `pip install *.whl` +Install 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. -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`. +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`. ## Installation @@ -76,12 +75,12 @@ To install: source lbry-venv/bin/activate pip install -r requirements.txt - pip install . + pip install --editable . ``` To start LBRY, run `lbrynet-daemon` in a terminal. -To verify your install, `which lbrynet-daemon` should return a path inside of the `lbry-venv` folder created by the `virtual-env` command. +To verify your install, `which lbrynet-daemon` should return a path inside of the `lbry-venv` folder created by the `virtualenv` command. ## Making a Change @@ -94,7 +93,7 @@ source lbry-venv/bin/activate Then run: ``` -python setup.py install +pip install --editable . ``` This will update `lbrynet-daemon` and other executables. From 18a0b07181ccaba8cd86049ce33021f371046497 Mon Sep 17 00:00:00 2001 From: Alex Grin Date: Tue, 24 Jan 2017 11:52:02 -0500 Subject: [PATCH 5/5] Update INSTALL.md --- INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 4d8a7832a..f2c0a8fc3 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -57,7 +57,7 @@ Currently, available binaries include: - requests - gmpy -Install each of the preceding binaries with `pip install *.whl` +Install the above binaries with `pip install *.whl` Install pywin32 system files by run `python.exe Scripts\pywin32_postinstall.py -install` from an elevated command prompt.