Changes between Version 8 and Version 9 of Developers

Timestamp:

03/15/09 01:34:52 (18 months ago)

Author:

msfrank

Comment:

--

Developers

@@ -2 +2 @@
 = Developer Documentation =
 
+=== Getting Started ===
+
 The first thing a new developer will likely want to do is grab the latest version of Higgins and build it; for these instructions see the [wiki:BuildingFromSource] page.  After getting it installed, try getting a feel for how Higgins works by reading some of the [wiki:Users user documentation].
 
+=== Getting Deeper ===
+
+The [wiki:ServerArchitecture server architecture] page gives a high level description of Higgins, including links to code documentation extracted using pydoc.  For an overview of how plugins work in Higgins, read the [wiki:AnatomyOfAPlugin] page.
+
+=== Getting Involved ===
+
 There is a google group for discussing higgins development: [http://groups.google.com/group/higgins-developers higgins-developers@googlegroups.com].  Note that user questions will not be answered on this list.
-
-== Architecture ==
-
-At the highest level, Higgins is logically divided into ''core'' and ''plugins''.  Core is mostly low-level infrastructure needed to support the plugins, which do all of the really interesting stuff.
-
-=== Core ===
-
-|| '''Package''' || '''Description'''                                                 ||
-|| higgins       || application startup, plugin loading, settings management, logging ||
-|| higgins.core  || web interface, database management                                ||
-|| higgins.data  || static data (CSS, django templates)                               ||
-|| higgins.netif || functions for getting information about network interfaces        ||
-|| higgins.upnp  || UPnP infrastructure, SOAP parsing                                 ||
-
-=== Plugins ===
-
-Higgins supports multiple types of plugins.  In order to create a plugin, you subclass from the appropriate Higgins class.  Currently the following classes can be subclassed to create a plugin:
-
-|| '''Base class'''                       || '''Description'''
-|| higgins.core.configurator.Configurator || Provides a declarative interface to manage settings   ||
-|| higgins.service.Service                || Provides a simple interface to do work asynchronously ||
-|| higgins.upnp.device.Device             || Provides an interface to describe a UPnP device       ||
-
-For an overview of how plugins work in Higgins, read the [wiki:AnatomyOfAPlugin] page.