Index: README.md =================================================================== diff -u -rfc1912b6369d6709c4c4a0bd83bfcd3fa0639a6f -rf5992e425a0fea2f531119bd762853227a4bed77 --- README.md (.../README.md) (revision fc1912b6369d6709c4c4a0bd83bfcd3fa0639a6f) +++ README.md (.../README.md) (revision f5992e425a0fea2f531119bd762853227a4bed77) @@ -21,31 +21,32 @@ ### Install directly from this repository - Assumes your ssh key has already been setup with our internal BitBucket servers -- Assumes your computer is in the office or that you are on the VPN +- Assumes your computer is in the office or that you are using LogMeIn. The VPN has a DNS issue which may break +the installation. -How to install from the dialin_refactoring_3 branch (Available) +All release versions will eventually be placed on their own separate branch to facilitate +backwards compatibility and a fully accessible and testable API version history. + +How to install from the master branch, which contains the latest in-development changes (Available!) + ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate -branch="dialin_refactoring_3" -pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git ``` -All release versions will eventually be placed on their own separate branch to facilitate -backwards compatibility and a fully accessible and testable API version history. +How to install a specific release version (Not yet available) -How to install from the master branch (Not yet available) -- Will be possible as soon as the dialin_refactoring_3 branch has been merged with the master branch - ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate -pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git +branch="0.0.1" # update the branch_name here +pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch ``` ### Install from a pre-built .whl file: