SF.net SVN: geany-plugins:[2234] trunk/geany-plugins/README.draft

[cesspit at users.sourceforge.net]

Revision: 2234
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=2234&view=rev
Author:   cesspit
Date:     2011-10-06 11:39:51 +0000 (Thu, 06 Oct 2011)
Log Message:
-----------
fish draft for a plugins README file

Added Paths:
-----------
    trunk/geany-plugins/README.draft

Added: trunk/geany-plugins/README.draft
===================================================================
--- trunk/geany-plugins/README.draft	                        (rev 0)
+++ trunk/geany-plugins/README.draft	2011-10-06 11:39:51 UTC (rev 2234)
@@ -0,0 +1,39 @@
+Plugin name
+=============
+
+.. image:: http://www.geany.org/images/geany_main_small.png
+   :width: 400
+   :alt: image of a plugin in work (if applicable)
+   :align: right
+   :target: http://www.geany.org/uploads/Gallery/geany_main.png
+
+.. contents::
+
+About
+------
+
+General information about what a plugin is all about.
+
+Features
+-----------
+
+ * list of features a plugin exposes
+ * list of features a plugin exposes
+ * list of features a plugin exposes
+ 
+Usage
+------
+
+Information about using a plugin:
+descriptions, use-cases, hotkeys lists,
+configuration, known bugs etc.
+
+Requirements
+------------
+
+What a user needs to install / use a plugin.
+
+Contact developers
+----------------------
+
+E-mails, IRC, other contacts

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.