mirror of
https://github.com/jlu5/PyLink.git
synced 2024-12-24 11:42:51 +01:00
README: more thorough description of branches & installation
This commit is contained in:
parent
3e2c6ea1b7
commit
02f3c71e8b
15
README.md
15
README.md
@ -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,11 +32,16 @@ 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)
|
||||||
1) Make sure you're running the right pip command: on most distros, pip for Python3 uses the command `pip3`.
|
- 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`.
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user