GitHub/PyLink
3
0
Fork 0
mirror of https://github.com/jlu5/PyLink.git synced 2024-12-24 03:33:10 +01:00
Code Issues Projects Releases Wiki Activity

README: add setuptools dependency & clarify --user

Browse Source 
Thanks to kevin on KoaxIRC for reporting.
This commit is contained in:
James Lu 2016-07-17 20:26:32 -07:00 committed by GitHub
parent 8169a2b751
commit 5d8f3036e7
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -23,6 +23,7 @@ PyLink and any bundled software are licensed under the Mozilla Public License, v
## Dependencies
* Python 3.4+
* Setuptools (`pip install setuptools`)
* PyYAML (`pip install pyyaml`)
* [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))
@ -55,7 +56,7 @@ Other TS6 and P10 variations may work, but are not officially supported.
## 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!