mirror of
https://github.com/jlu5/PyLink.git
synced 2025-02-17 14:01:03 +01:00
README: move Apt / PPA instructions to after source builds and pip
These aren't tested as thoroughly.
This commit is contained in:
parent
69b112eb44
commit
e036449c72
20
README.md
20
README.md
@ -27,16 +27,6 @@ You can also find support via our IRC channels: `#PyLink @ irc.overdrivenetworks
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Installing via Debian APT repository (stable branch only)
|
|
||||||
|
|
||||||
[The Utopia Repository](https://packages.overdrivenetworks.com/) hosts `.deb` packages for PyLink. For Debian Jessie (stable) and Stretch/sid (testing), the `pylink` package and its dependencies are available in the `main` section. See https://packages.overdrivenetworks.com/#instructions for setup instructions.
|
|
||||||
|
|
||||||
Upon installing `pylink`, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively. You can also install a local copy of the [PyLink API reference](https://pylink.github.io/), which is provided by the `pylink-doc` package.
|
|
||||||
|
|
||||||
### Installing via Ubuntu PPA (stable branch only)
|
|
||||||
|
|
||||||
Ubuntu packages for PyLink are available from the [PyLink PPA](https://launchpad.net/~tacocat/+archive/ubuntu/pylink) for Ubuntu 14.04 LTS (trusty) and above. Like with the Debian installation, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively.
|
|
||||||
|
|
||||||
### Installing from source
|
### Installing from source
|
||||||
|
|
||||||
First, make sure the following dependencies are met:
|
First, make sure the following dependencies are met:
|
||||||
@ -65,6 +55,16 @@ First, make sure the following dependencies are met:
|
|||||||
|
|
||||||
3) Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.
|
3) Download or copy https://github.com/GLolol/PyLink/blob/master/example-conf.yml for an example configuration.
|
||||||
|
|
||||||
|
### Installing via Debian APT repository (stable branch only)
|
||||||
|
|
||||||
|
[The Utopia Repository](https://packages.overdrivenetworks.com/) hosts `.deb` packages for PyLink. For Debian Jessie (stable) and Stretch/sid (testing), the `pylink` package and its dependencies are available in the `main` section. See https://packages.overdrivenetworks.com/#instructions for setup instructions.
|
||||||
|
|
||||||
|
Upon installing `pylink`, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively. You can also install a local copy of the [PyLink API reference](https://pylink.github.io/), which is provided by the `pylink-doc` package.
|
||||||
|
|
||||||
|
### Installing via Ubuntu PPA (stable branch only)
|
||||||
|
|
||||||
|
Ubuntu packages for PyLink are available from the [PyLink PPA](https://launchpad.net/~tacocat/+archive/ubuntu/pylink) for Ubuntu 14.04 LTS (trusty) and above. Like with the Debian installation, example configurations and docs will be in `/usr/share/doc/pylink/examples` and `/usr/share/doc/pylink/docs` respectively.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
1) Rename `example-conf.yml` to `pylink.yml` (or a similarly named `.yml` file) and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update!
|
1) Rename `example-conf.yml` to `pylink.yml` (or a similarly named `.yml` file) and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update!
|
||||||
|
Loading…
x
Reference in New Issue
Block a user