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
2013-09-01 17:19:03 +01:00
parent 69fa4a3b5e
commit 33fe71c44e
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -8,10 +8,12 @@ Building Profanity with plugin support
Check out the `plugins` branch and run the usual: Check out the `plugins` branch and run the usual:
```
./bootstrap.sh ./bootstrap.sh
./configure ./configure
make make
sudo make install sudo make install
```
The last step will create a shared library `libprofanity` and install headers required for developing C plugins. If you don't want to run any C plugins, you can omit the last step. The last step will create a shared library `libprofanity` and install headers required for developing C plugins. If you don't want to run any C plugins, you can omit the last step.
@@ -20,13 +22,13 @@ You will need python-dev, ruby-dev and libtool packages installed on your system
Loading plugins Loading plugins
--------------- ---------------
1) Copy the plugin 1. Copy the plugin
For Python and Ruby plugins, copy the plugin to `$XDG_DATA/profanity/plugins/`, (`~/.local/share/profanity/plugins/` on most systems). For Python and Ruby 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. For C plugins, build the plugin using the supplied Makefile, and then copy the `.so` file to the same location.
2) Add to profrc 2. Add to profrc
For all types of plugins, the list of plugins to acutally load when starting Profanity is defined in `$XDG_CONFIG/profanity/profrc` (`~/.config/profanity/profrc` on most systems). For all types of plugins, the list of plugins to acutally load when starting Profanity is defined in `$XDG_CONFIG/profanity/profrc` (`~/.config/profanity/profrc` on most systems).
@@ -37,3 +39,14 @@ For example:
load=browser.py;connect.py;ChatStart.rb;cricket-score.py;platform-info.py;whoami.py;ascii.py load=browser.py;connect.py;ChatStart.rb;cricket-score.py;platform-info.py;whoami.py;ascii.py
``` ```
Example plugin code
-------------------
Whilst the API is being developed, the following test plugins are a good reference of possible hooks and API calls available:
```
python-test.py
RubyTest.rb
test-c-plugin/*
```