diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-12-04 14:31:41 -0500 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-12-04 14:31:41 -0500 |
commit | 3384ba49fa06c06794665407f22553b3ae0de498 (patch) | |
tree | 491fc358861baa48d615d0cc13037e677c6a0d9a /doc/plugin-registration.markdown | |
parent | 7719703dce4e6353f9c5cccacccb7e364159aa1e (diff) |
Update Changelog, contributors list and doc
Diffstat (limited to 'doc/plugin-registration.markdown')
-rw-r--r-- | doc/plugin-registration.markdown | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/plugin-registration.markdown b/doc/plugin-registration.markdown index a9273e1d..2c80aab3 100644 --- a/doc/plugin-registration.markdown +++ b/doc/plugin-registration.markdown @@ -1,6 +1,28 @@ Plugin Registration =================== +Project skeleton generator +-------------------------- + +You can use `cookiecutter` to create the project structure of your plugin automatically. + +Install Cookiecutter: + +```bash +pip install -U cookiecutter +``` + +Run Kanboard cookiecutter: + +```bash +cookiecutter gh:kanboard/cookiecutter-plugin +plugin_name [My Plugin]: Some Plugin +plugin_namespace [MyPlugin]: SomePlugin +plugin_author [Plugin Author]: Me +plugin_description [My plugin is awesome]: +plugin_homepage [https://github.com/kanboard/plugin-myplugin]: +``` + Directory structure ------------------- |