README.Plugins


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

#
# $Id: README.Plugins,v 1.1 2004/01/06 17:33:45 reinelt Exp $
#


This file contains instructions for writing plugins to lcd4linux.

- use the file 'plugin_sample.c' as a template
- copy the file to 'plugin_yourname.c' and edit
- replace the "$Id..." in the first line with "$Id: README.Plugins,v 1.1 2004/01/06 17:33:45 reinelt Exp $"
- add a short description what this plugin is for
- add your copyright notice (important: your name and email)
- replace the "$Log..." with "$Log: README.Plugins,v $
- replace the "$Log..." with "Revision 1.1  2004/01/06 17:33:45  reinelt
- replace the "$Log..." with "
- replace the "$Log..." with "Evaluator: functions with variable argument lists
- replace the "$Log..." with "Evaluator: plugin_sample.c and README.Plugins added
- replace the "$Log..." with ""
- remove all Log lines until "*/"
- do some documentation (I know that real programmers write programs, not documentation)
- use one or more of the example functions as templates for your own functions
- register your new functions to the init() function, delete the sample ones
- edit 'plugin.c', add a prototype and the call to your plugin_init_* function
- edit 'Makefile.am' and add your 'plugin_*.c' to lcd4linux_SOURCES
- compile and test with interactive mode ('-i')
- send me a patch (or check in if you have developer CVS access)
- enjoy