README.txt

   1 augment
   2     by Phil Hagelberg (c) 2007
   3     http://augment.rubyforge.org
   4
   5 == Description
   6
   7 Augment is a framework for gathering metadata from code and displaying
   8 it. This metadata would include test failures, test coverage levels,
   9 complexity metrics, and others. Display frontends will be pluggable so
  10 as to interface with many editors.
  11
  12 == Usage
  13
  14 == Design
  15
  16 Augment is designed to be generalized; if you want to collect
  17 different kinds of data you can just write a new backend. If you want
  18 to display the data in an unsupported editor, you can write a new
  19 frontend.
  20
  21 === Backends
  22
  23 Each backend takes a filename or glob and outputs the metadata about
  24 that file into the .augment directory, created in the project root.
  25 Metadata is stored as layer information in JSON. Each backend also
  26 needs an initiator command to kick off the process that gathers the
  27 metadata, with the exception of auto-initiating backends like autotest.
  28
  29 === Frontends
  30
  31 Each frontend is implemented within an editor or IDE. It watches the
  32 .augment directory for changes and applies them to the open buffers
  33 when they happen.  The user can choose what augmentations he wants
  34 displayed either globally or on a per-file basis. He can also control
  35 when backend initiators should be started.
  36
  37 === Layers
  38
  39 A layer consists of a single piece of metadata about a file. This is
  40 expressed in terms of the range it applies to in the file, its color,
  41 and the message associated with it.
  42
  43 == Support
  44
  45 Backends:
  46
  47 * Tests or specs
  48 * Heckle (planned)
  49 * Rcov (planned)
  50 * Flog (planned)
  51 * Performance (planned)
  52
  53 Frontends:
  54
  55 * Emacs
  56 * ANSI color codes (for shells)
  57 * Vim (planned)
  58 * Textmate (planned)
  59
  60 == Issues
  61
  62 * Not really written yet.
  63
  64 == License
  65
  66 This is free software; you can redistribute it and/or modify it under
  67 the terms of the GNU General Public License as published by the Free
  68 Software Foundation; either version 3, or (at your option) any later
  69 version.
  70
  71 This file is distributed in the hope that it will be useful, but
  72 WITHOUT ANY WARRANTY; without even the implied warranty of
  73 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  74 General Public License for more details.
  75
  76 You should have received a copy of the GNU General Public License
  77 along with this software; see the file COPYING. If not, write to the
  78 Free Software Foundation at this address:
  79
  80   Free Software Foundation
  81   51 Franklin Street, Fifth Floor
  82   Boston, MA 02110-1301
  83   USA