From 5d8f3036e740ebdd905e3943038268954a68c60d Mon Sep 17 00:00:00 2001 From: James Lu Date: Sun, 17 Jul 2016 20:26:32 -0700 Subject: [PATCH] README: add setuptools dependency & clarify --user Thanks to kevin on KoaxIRC for reporting. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2075b47..77fb4cb 100644 --- a/README.md +++ b/README.md @@ -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!