devs/cproof-plugins
2
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
James Booth
2016-07-12 23:59:56 +01:00
committed by GitHub
parent 9c7f05305b
commit 64a97f5177
1 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -57,24 +57,16 @@ Python plugins: Enabled
Installing plugins Installing plugins
------------------ ------------------
1 - Copy the plugin Use the `/plugins install` command, e.g.
For Python, Ruby and Lua plugins, copy the plugin to `$XDG_DATA/profanity/plugins/`, (`~/.local/share/profanity/plugins/` on most systems).
For C plugins, build the plugin using the supplied Makefile, and then copy the `.so` file to the same location.
2 - Load the plugin
Run the `/plugins load <plugin>` command to load the plugin, e.g. `/plugins load browser.py`, the plugin can also be manually added to the config file `$XDG_CONFIG/profanity/profrc` (`~/.config/profanity/profrc` on most systems).
For example:
``` ```
[plugins] /plugins install ~/projects-git/profanity-plugins/say.py
load=browser.py;platform-info.py;ascii.py;pid.so
``` ```
Getting help on plugins: See the `/help plugins` for further plugin management commands.
More help on plugins
--------------------
* `/plugins` - Shows a list of loaded plugins. * `/plugins` - Shows a list of loaded plugins.
* `/help commands plugins` - Shows commands defined by plugins * `/help commands plugins` - Shows commands defined by plugins