SF.net SVN: ledger-smb:[4640] addons/README

[..hidden..]

Revision: 4640
          http://ledger-smb.svn.sourceforge.net/ledger-smb/?rev=4640&view=rev
Author:   einhverfr
Date:     2012-04-11 03:58:10 +0000 (Wed, 11 Apr 2012)
Log Message:
-----------
Adding README which provides basic install instructions among other basic documentation

Added Paths:
-----------
    addons/README

Added: addons/README
===================================================================
--- addons/README	                        (rev 0)
+++ addons/README	2012-04-11 03:58:10 UTC (rev 4640)
@@ -0,0 +1,40 @@
+ADDON STRUCTURE AND MANAGEMENT
+Chris Travers, 2012-04-11
+
+Basic Structure
+===================
+Each add-on is given a sub-directory with which to form a complete svn tree.
+Each tree is then divided into trunk, branches, tags, etc.  The trees are
+located under the major version of LedgerSMB they are coded against.  Add-ons
+may be usable with later versions of LedgerSMB but this is not guaranteed.
+
+Each addon maintains the LedgerSMB directory structure under it.  Consequently
+all add-ons copy their files into the main LedgerSMB instance.  This behavior
+may change in future versions though as it makes removing add-ons problematic.
+
+Installing an Add-On
+===================
+
+To install an add-on there are several important steps:
+
+1)  Copy files to respective locations (apply_addon.sh is a useful template 
+for this task)
+2)  Apply patches (they will be copied to the patches directory)
+3)  Apply database changes.  These also add menu items and the like.  Files here
+are usually coped to sql/modules.  Future versions of LedgerSMB should allow for
+additional LOADORDERS to be specified for general upgrades but this is not
+supported yet.
+
+
+Removing an Add-On
+==================
+Currently the only way to remove an add-on is to reverse the above steps
+manually.
+
+Opportunities for Better Administration via Enhancing LedgerSMB
+==============================================================
+
+1)  Put addons in their own namespaces and directories, making management of
+addon files easier
+2)  Web interface for installing addon database components
+3)  Removal of addon db components 

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