Update the documentation

(do not encourage people to copy the plugins)
This commit is contained in:
mathieui 2013-05-11 18:38:12 +02:00
parent dde153e85b
commit 1a349efeb1
3 changed files with 9 additions and 1 deletions

View file

@ -8,12 +8,16 @@ Here is a quick howto and a plugin index.
Setting up plugins
------------------
Poezio seeks the plugins in the :file:`~/.local/share/poezio/plugins/` dir (more
generally, the :file:`$XDG_DATA_HOME/poezio/plugins/` dir), but that can be changed
by setting the :term:`plugins_dir` option to the directory where you want to
put your plugins.
This means that if you want to use a plugin, you have to copy it (the .py file or the directory) into :term:`plugins_dir`.
By default, poezio will also seek the plugins in :file:`../plugins`, in the source
directory, in order to always load the latest versions. You should put a plugin
in :file:`$XDG_DATA_HOME/poezio/plugins` only if you have a custom version (that
will override the one in :file:`../plugins`), or if it is a plugin you made.
Plugin autoload

View file

@ -19,6 +19,7 @@ from args import parse_args
from common import safeJID
class Config(RawConfigParser):
"""
load/save the config to a file

View file

@ -1,3 +1,6 @@
-e git://github.com/fritzy/SleekXMPP.git@develop#egg=SleekXMPP
dnspython3==1.10.0
sphinx==1.2b1
argparse
pyinotify
python-mpd2