Next: imageLoader
Up: Modules in brief
Previous: Module Development Kit
  Contents
  Index
Packaging and releasing
Here are some guidelines to help you release your module:
- Write documentation. This is a complete must, because if
you don't write it, people won't know what module functions are available
in the package, and won't be able to use your module, and then I think
you'd missing the point. Be sure to explain what each module function
does, and what arguments it may receive.
- It's a good idea to add a prefix to the module functions of a module
package. For example: foo_clean(), foo_recognize().
- Do not duplicate code. If someone already did what you want, don't
replicate it in your code. By the other hand, don't ask to the user
to have several libraries of module packages; if you need only a function,
have it in your own code (respect the software license).
- There's already a easy way to package: type make dist. It
will generate the appropriate tar file.
- Read the Software Release Practice HOWTO.
- Take a look at existing modules. If you are having some problem, chances
are that by peeking at other's work you can find a solution. This
is one of the most important laws of software coding. Be nice and
add a thanks note to your documentation.
Next: imageLoader
Up: Modules in brief
Previous: Module Development Kit
  Contents
  Index
root
2002-02-17