ide/bioperl-mode/README

   1 $Id$
   2
   3 bioperl-mode : a minor mode for BioPerl documentation and template insertion
   4
   5 Release 0.1
   6
   7 == Description ==
   8
   9 bioperl-mode is an Emacs minor mode that allows rapid browsing of
  10 BioPerl pod and source code. It contains facilities for inserting
  11 coding and documentation templates that save typing and ensure BioPerl
  12 best practice compliance.
  13
  14 See http://www.bioperl.org/wiki/Emacs_bioperl-mode for a full
  15 description and list of features.
  16
  17 == Installation ==
  18
  19 Copy the file dist/bioperl-mode.tar into your Emacs root directory,
  20 often
  21
  22  /usr/share/emacs/[version]/
  23
  24 in Linux, or
  25
  26  C:\Program Files\emacs-[version]\
  27
  28 in Windows.
  29
  30 Untar in situ with
  31
  32  $ tar -xf bioperl-mode.tar
  33
  34 In your .emacs file, add the line
  35
  36  (require 'bioperl-mode)
  37
  38 and restart.
  39
  40 Source files are available in site-lisp and etc directories.
  41
  42 For more details, see http://www.bioperl.org/wiki/Emacs_bioperl-mode.
  43
  44 == Support ==
  45
  46 Please direct questions to bioperl-l@lists.open-bio.org
  47
  48 Happy coding!