doc/readme.texi

   1 \input texinfo   @c -*-texinfo-*-
   2 @comment %**start of header
   3 @setfilename readme.info
   4 @settitle ESS --- Emacs Speaks Statistics
   5 @comment %**end of header
   6
   7 @include ess-defs.texi
   8 @node General Information, , (dir), (dir)
   9 @comment  node-name,  next,  previous,  up
  10 @chapter General Information: README
  11 @cindex README
  12
  13 This is the README file for the distribution of ESS version
  14 @include ../VERSION
  15
  16 ESS is a GNU Emacs and XEmacs mode for interactive statistical programming
  17 and data analysis.  Languages supported: the S family (S 3/4, S-PLUS
  18 3/4/5/6/7, and R), SAS, XLispStat, Stata and BUGS.  Installation help can
  19 be found in sections for both Unix and Windows.  ESS grew out of the desire
  20 for bug fixes and extensions to S-mode and SAS-mode as well as a consistent
  21 union of their features in one package.
  22
  23 The current development team is led by Martin Maechler since August
  24 2004. Former project leader A.J. (Tony) Rossini
  25 (@email{rossini@@blindglobe.net}) did the initial port to
  26 XEmacs and has been the primary coder.  Martin Maechler
  27 (@email{maechler@@stat.math.ethz.ch}) and Kurt Hornik
  28 (@email{Kurt.Hornik@@R-project.org}) have assisted with S-PLUS, S4, R, and
  29 XLispStat.  Stephen Eglen (@email{stephen@@gnu.org}) has worked mostly
  30 on R support.  Richard M. Heiberger (@email{rmh@@temple.edu}) has
  31 assisted with S-PLUS and S4 development for Windows.  Richard and
  32 Rodney A. Sparapani (@email{rsparapa@@mcw.edu}) have done much of the work
  33 implementing interactive SAS (@iESS{[SAS]}) and batch SAS (@ESS{[SAS]}) support.
  34
  35 We are grateful to the previous developers of S-mode (Doug Bates, Ed Kademan,
  36 Frank Ritter, David M. Smith), SAS-mode (Tom Cook) and Stata-mode (Thomas
  37 Lumley).
  38 @c The name is ESS.  Not ESS-mode.
  39
  40 @menu
  41 * License::
  42 * Starting an ESS Process::
  43 * New Features::
  44 * Current Features::
  45 * Stability::
  46 * Requirements::
  47 * Latest Version::
  48 * Installation::
  49 * Reporting Bugs::
  50 * Mailing Lists::
  51 * Authors::
  52 @end menu
  53
  54 @node License, Starting up, General Information, General Information
  55 @comment  node-name,  next,  previous,  up
  56 @section License
  57
  58 @include license.texi
  59
  60 @node Starting up, New Features, License, General Information
  61 @section Starting an ESS process
  62 To start an @Sl{} session on Unix or on Windows when you
  63 use the Cygwin bash shell, simply type @kbd{M-x S RET}.
  64
  65 To start an @Sl{} session on Windows when you
  66 use the MSDOS prompt shell, simply type @kbd{M-x S+6-msdos RET}.
  67
  68
  69 @node New Features, Current Features, Starting up, General Information
  70 @comment  node-name,  next,  previous,  up
  71 @section New Features
  72
  73 @include newfeat.texi
  74
  75 @node Current Features, Stability, New Features, General Information
  76 @comment  node-name,  next,  previous,  up
  77 @section Current Features
  78
  79 @include currfeat.texi
  80
  81 @node Stability, Requirements, Current Features, General Information
  82 @comment  node-name,  next,  previous,  up
  83 @section Stability
  84
  85 @include stabilty.texi
  86
  87 @node Requirements, Latest Version, Stability, General Information
  88 @comment  node-name,  next,  previous,  up
  89 @section Requirements
  90
  91 @include requires.texi
  92
  93 @node Latest Version, Installation, Requirements, General Information
  94 @comment  node-name,  next,  previous,  up
  95 @section Getting the Latest Version
  96
  97 @include getting.texi
  98 @c NOTE: The above INCLUDES inst_svn.texi (Subversion/SVN Installation)
  99
 100 @c    vvvvvvvvvvvv node name  *must* match the one in ./ess.texi !
 101 @node Installation, Reporting Bugs, Latest Version, General Information
 102 @comment  node-name,  next,  previous,  up
 103 @section Installation (from tar file)
 104
 105 @include inst_tar.texi
 106
 107 @node Reporting Bugs, Mailing Lists, Installation, General Information
 108 @comment  node-name,  next,  previous,  up
 109 @section Reporting Bugs
 110
 111 @include bugrept.texi
 112
 113 @node Mailing Lists, Authors, Reporting Bugs, General Information
 114 @comment  node-name,  next,  previous,  up
 115 @section Mailing Lists
 116
 117 @include mailing.texi
 118
 119 @node Authors,  , Mailing Lists, General Information
 120 @comment  node-name,  next,  previous,  up
 121 @section Authors
 122
 123 @include authors.texi
 124
 125 @bye
 126 @c Remember to delete these lines before creating the info file.
 127 @iftex
 128 @lucidbook
 129 @bindingoffset = 0.5in
 130 @parindent = 0pt
 131 @end iftex
 132
 133 @comment Local Variables:
 134 @comment TeX-master: "readme.texi"
 135 @comment End: