GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-25 04:02:45 +01:00
Code Issues Projects Releases Wiki Activity

README: more thorough description of branches & installation

Browse Source
This commit is contained in:
James Lu 2016-08-31 22:03:43 -07:00 committed by GitHub
parent 3e2c6ea1b7
commit 02f3c71e8b
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -20,7 +20,7 @@ You can also find support via our IRC channels: `#PyLink @ irc.overdrivenetworks
## Installation ## Installation
### Installing from source (recommended) ### Installing from source
First, make sure the following dependencies are met: First, make sure the following dependencies are met:
@ -32,10 +32,15 @@ First, make sure the following dependencies are met:
1) Clone the repository: `git clone https://github.com/GLolol/PyLink && cd PyLink` 1) Clone the repository: `git clone https://github.com/GLolol/PyLink && cd PyLink`
2) Install PyLink using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install) 2) Pick your branch.
- Note: `--user` is a *literal* string; *do not* replace it with your username. - By default you'll be on the **master** (stable) branch, which is bugfix only for the most part (except when a new stable release is introduced).
- However, new features or more intensive bug fixes may not always be included. Instead, the **devel** (pre-release) branch is where active development goes, and it can be accessed by running `git checkout devel` in your Git tree.
### Installing via PyPI 3) Install PyLink using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install)
- Note: `--user` is a *literal* string; *do not* replace it with your username.
- **Whenever you switch branches or update PyLink's sources via `git pull`, you will need to re-run this command for changes to apply!**
### Installing via PyPI (stable branch only)
1) Make sure you're running the right pip command: on most distros, pip for Python 3 uses the command `pip3`. 1) Make sure you're running the right pip command: on most distros, pip for Python 3 uses the command `pip3`.
2) Run `pip3 install pylinkirc` to download and install PyLink. pip will automatically resolve dependencies. 2) Run `pip3 install pylinkirc` to download and install PyLink. pip will automatically resolve dependencies.