1. Manuals
  2. Leap-15.6
  3. libelektra-devel-doc
  4. md_src_plugins_template_README(3elektra)

Scroll to navigation

md_src_plugins_template_README(3elektra) Elektra md_src_plugins_template_README(3elektra)

NAME

md_src_plugins_template_README - Plugin: template

  • infos = Information about the template plugin is in keys below
  • infos/author = Author Name elektra@libelektra.org
  • infos/licence = BSD
  • infos/needs =
  • infos/provides =
  • infos/recommends =
  • infos/placements =
  • infos/status = recommended productive maintained reviewed conformant compatible coverage specific unittest shelltest tested nodep libc configurable final preview memleak experimental difficult unfinished old nodoc concept orphan obsolete discouraged -1000000
  • infos/metadata =
  • infos/description = one-line description of template

Copy this template if you want to start a new plugin written in C.

Usage

You can use scripts/copy-template to automatically rename everything to your plugin name:



    cd src/plugins


    ../../scripts/copy-template yourplugin

Then update the README.md of your newly created plugin:

  • enter your full name+email in infos/author
  • make sure status and other clauses conform to descriptions in doc/CONTRACT.ini
  • update the one-line description above
  • add your plugin in src/plugins/README.md
  • and rewrite the rest of this README.md to give a great explanation of what your plugin does

Dependencies

None.

Examples

None.

Limitations

None.

Mon Jan 15 2018 Version 0.8.20