mirror of
https://github.com/jlu5/PyLink.git
synced 2024-12-24 19:52:53 +01:00
README: add setuptools dependency & clarify --user
Thanks to kevin on KoaxIRC for reporting.
This commit is contained in:
parent
8169a2b751
commit
5d8f3036e7
@ -23,6 +23,7 @@ PyLink and any bundled software are licensed under the Mozilla Public License, v
|
|||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
* Python 3.4+
|
* Python 3.4+
|
||||||
|
* Setuptools (`pip install setuptools`)
|
||||||
* PyYAML (`pip install pyyaml`)
|
* PyYAML (`pip install pyyaml`)
|
||||||
* [ircmatch](https://github.com/mammon-ircd/ircmatch) (`pip install ircmatch`)
|
* [ircmatch](https://github.com/mammon-ircd/ircmatch) (`pip install ircmatch`)
|
||||||
* *For the servprotect plugin*: [expiringdict](https://github.com/mailgun/expiringdict) (note: unfortunately, installation is broken in pip due to [mailgun/expiringdict#13](https://github.com/mailgun/expiringdict/issues/13))
|
* *For the servprotect plugin*: [expiringdict](https://github.com/mailgun/expiringdict) (note: unfortunately, installation is broken in pip due to [mailgun/expiringdict#13](https://github.com/mailgun/expiringdict/issues/13))
|
||||||
@ -55,7 +56,7 @@ Other TS6 and P10 variations may work, but are not officially supported.
|
|||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
1) Install PyLink by using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install)
|
1) Install PyLink by using `python3 setup.py install` (global install) or `python3 setup.py install --user` (local install; note: `--user` is a *literal* string)
|
||||||
|
|
||||||
2) Rename `example-conf.yml` to `pylink.yml` and configure your instance there. Note that the configuration format isn't finalized yet - this means that your configuration may break in an update!
|
2) Rename `example-conf.yml` to `pylink.yml` 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…
Reference in New Issue
Block a user