SF.net SVN: geany-plugins:[2211] trunk/geany-plugins/HACKING

[frlan at users.sourceforge.net]

Revision: 2211
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=2211&view=rev
Author:   frlan
Date:     2011-09-24 22:28:32 +0000 (Sat, 24 Sep 2011)
Log Message:
-----------
Addming some minor requirements for documentation to HACKING file

Modified Paths:
--------------
    trunk/geany-plugins/HACKING

Modified: trunk/geany-plugins/HACKING
===================================================================
--- trunk/geany-plugins/HACKING	2011-09-21 18:30:27 UTC (rev 2210)
+++ trunk/geany-plugins/HACKING	2011-09-24 22:28:32 UTC (rev 2211)
@@ -11,11 +11,13 @@
 This file contains some useful information for any plugin developer, and
 especially for new plugin developers.
 
+
 Building your plugin
 --------------------
 You should first read either `README` or `README.waf` depending on whether
 you want to use Autotools or Waf to build the plugins.
 
+
 Autotools Build System
 ^^^^^^^^^^^^^^^^^^^^^^
 The Autotools build system automatically enables some code checking
@@ -33,3 +35,37 @@
 necessarily and always right -- though they try.
 If you think they reports wrong problems, please file a report on the
 appropriate place (either the mailing lists or the geany-plugins bug tracker).
+
+
+Documentation
+-------------
+
+README
+^^^^^^
+Inside each plugin folder, that should be a README located.
+
+
+Something about the markup being used
+#####################################
+
+The README is intended to be written in
+`Restructured Text <http://sphinx.pocoo.org/rest.html>`_
+(as this document is) and therefor should be working e.g. with running
+rst2html or similar tools. The reason for is, that these information are
+getting used by generating content of http://plugins.geany.org.
+
+
+Content that shall be in
+########################
+
+The documentation should include a minimum on content. This means a
+detailed description on features offered by the plugins and usage of
+this features. But also it should include some basic information
+which is making it easier for the user to get in contact or to find
+help in case of any issues.
+
+* author(s) of plugin and its mail addresses
+* web pages, if there are any beside of http://plugins.geany.org
+* know issues
+* bug tracker
+* dependencies

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