README
author Dave Townsend <dtownsend@oxymoronical.com>
Tue, 19 Jan 2010 11:12:05 -0800
changeset 140 56ac97ec297d
permissions -rw-r--r--
Add licenses, a readme and basic data sets
     1 This is a Django web application for displaying XPCOM interfaces and their
     2 differences across multiple application versions. Add it to a regular Django
     3 setup, normally the app is called xpcomref.
     4 
     5 A script (buildapi) builds the database for the web application using data
     6 provided from built versions of the application and the original source code.
     7 
     8 Data about applications must be gathered by dropping dumpcomponents.js into the
     9 application's components directory and then running the application with a clean
    10 profile. After startup an "apislurp" directory will be created on the desktop
    11 and a series of files written there. The component will log its progress to the
    12 standard text console. Once completed the application should be quit as it may
    13 have become unstable. These data files, along with any xpt file shipped with the
    14 application should be placed into the applications directory as follows:
    15 
    16 applications
    17 - <Application name>
    18   - <Application version>
    19     - platform (contains the version of the platform this app is based on)
    20     - <OS>
    21       - application (built by dumpcomponents.js)
    22       - components (built by dumpcomponents.js)
    23       - interfaces (built by dumpcomponents.js)
    24       - compreg.dat (built by dumpcomponents.js)
    25       - xpti.dat (built by dumpcomponents.js)
    26       - *.xpt (copied from the application)
    27 
    28 There should also be a source directory as follows:
    29 
    30 sources
    31 - platform
    32   - <Platform version> (matches the text in the platform file in the applications directory)
    33     - source (contains the URL where the source code can be viewed)
    34     - full copy of the source idls for this version of the platform
    35 
    36 These directories only need exist on one machine to build the initial database.
    37 Running the "buildapi" script will scan these directories and generate the
    38 database which may then be transferred to a webhost.
    39 
    40 The following is probably necessary in Django's root urls.py:
    41 
    42 urlpatterns = patterns('',
    43   (r'^(?P<path>(?:images|styles|silk|scripts)/.*)$', 'django.views.static.serve', {'document_root': 'xpcomref'}),
    44   (r'', include('apislurp.xpcomref.urls'))
    45 )