docs
[pspp] / README
diff --git a/README b/README
index 3034f989172df95ff824cb6d4ea047e3c6863fd3..9cc48a836497a1428d10f8cd79144537505e1853 100644 (file)
--- a/README
+++ b/README
@@ -1,60 +1,45 @@
-PSPP is a program for statistical analysis of sampled data. It
-interprets commands in the SPSS language and produces tabular output
-in ASCII, PostScript, or HTML format.
+PSPP is a program for statistical analysis of sampled data.  It is
+a free replacement for the proprietary program SPSS.
 
-PSPP development is ongoing. It already supports a large subset of
-SPSS's transformation language.  Its statistical procedure support is
-currently limited, but growing.
+PSPP supports T-tests, ANOVA and GLM analyses, factor analysis,
+non-parametric tests, linear and logistic regression, clustering,
+and other statistical features.  PSPP produces statistical reports in
+plain text, PDF, PostScript, CSV, HTML, SVG, and OpenDocument formats.
+It can import data from OpenDocument, Gnumeric, text and SPSS formats.
 
-Instructions for installation are in INSTALL.  Before you install
-PSPP, you will need to install certain prerequisites:
+PSPP has both text-based and graphical user interfaces.  The PSPP
+user interface has been translated into a number of languages.
 
-    * An ANSI C compiler and tool chain.
+Instructions for PSPP installation are in INSTALL, including a list of
+prerequisite packages and other PSPP-specific information.  Full
+documentation on PSPP's language is also included.
 
-    * The GNU Scientific Library (libgsl), version 1.6 or later,
-      including libgslcblas included with GSL.
-
-    * Perl, version 5.005_03 or later.  (Perl is required during build
-      but not after installation.)
-
-    * pkg-config (only if you need to regenerate configure after
-      modifying configure.ac).
-
-    * iconv, which should be installed as part of a Unix-like system.
-      If you don't have a version already, you can install GNU
-      libiconv (http://www.gnu.org/software/libiconv/).
-
-    * Optional: libncurses.  Without it, PSPP will assume it is
-      running in an 80x25 terminal.
-
-    * Optional: libreadline and libhistory.  Without them, interactive
-      command editing and history features will be disabled.
+For information on differences from previous versions, please see file
+NEWS.
 
-    * Optional: libplot (from GNU plotutils).  Without it,
-      graphing features will not work.  If you do not have it
-      installed, you must run `configure' with --without-libplot.
+Source code for the latest release of PSPP is available at
+ftp://ftp.gnu.org/pub/gnu/pspp/.  Test releases are at
+ftp://alpha.gnu.org/gnu/pspp/.  Development sources are available
+at http://savannah.gnu.org/projects/pspp
 
-    * Optional: GTK+ version 2.6.0 or later (2.10.2 or later is 
-      recommended), plus libglade 2.0 or later.  Without them, the 
-      GUI will not be built.  If you do not have these installed, you 
-      must run `configure' with --without-gui.
+The following miscellaneous notes apply to this release:
 
-    * Optional: Texinfo 4.7 or later, if you want to build the
-      documentation in PostScript or PDF format.
+       * On a few operating systems, such as OpenBSD, some of the
+          tests may fail with messages similar to: 'Warning: cannot
+          create a converter for "646" to "UTF-8"'.  These test
+          failures may safely be ignored.
 
-For information on differences from previous versions, please see file
-NEWS.  Full documentation on PSPP's language can be found in the doc/
-directory.
-          
-Source code for the latest release of PSPP is available at
-ftp://ftp.gnu.org/pub/gnu/pspp/.  Older versions may be obtained from
-ftp://alpha.gnu.org/gnu/pspp/.  Development sources are available from
-CVS at http://savannah.gnu.org/projects/pspp
-   
 Questions and comments about using PSPP may be sent to pspp-users@gnu.org.
 Bug reports may be filed at http://savannah.gnu.org/bugs/?group=pspp
-or emailed to bug-gnu-pspp@gnu.org.  (We prefer the web-based system
-because it makes it more difficult for us to lose track of bugs.)
+or emailed to bug-gnu-pspp@gnu.org.  We prefer the web-based system
+because it makes it more difficult for us to lose track of bugs, but we
+are happy to hear from users through any means.
+
+The PSPP bug tracker and bug reporting mailing list are public.  To
+privately report a security vulnerability in GNU PSPP, please send
+your report to the closed mailing list pspp-security@gnu.org.  The
+PSPP developers will help you assess your report and fix problems
+prior to public disclosure.
 
 The long term goals for PSPP are ambitious.  We wish to provide the
 following support to users:
@@ -63,21 +48,14 @@ following support to users:
           supports a large subset of it.
 
        * All the statistical procedures that someone is willing to
-          implement, whether they exist in SPSS or not.  Currently,
-          statistical support is limited, but growing.
+          implement, whether they exist in SPSS or not.
 
        * Compatibility with SPSS syntax, including compatibility with
           known bugs and warts, where it makes sense.  We also provide
           an "enhanced" mode in certain cases where PSPP can output
           better results that may surprise SPSS users.
 
-       * Friendly textual and graphical interfaces.  PSPP does not do
-          a good job of this yet.
-
-       * Attractive output, including graphs, in a variety of human-
-          and machine-readable formats.  PSPP currently produces
-          output in ASCII, PostScript, and HTML formats.  We will
-          enhance PSPP's output formatting in the future.
+       * Friendly textual and graphical interfaces.
 
        * Good documentation.  Currently the PSPP manual describes its
           language completely, but we would like to add information on
@@ -87,8 +65,9 @@ following support to users:
        * Efficient support for very large data sets.  For procedures
           where it is practical, we wish to efficiently support data
           sets many times larger than physical memory.  The framework
-          for this feature is already in place, but it has not been
-          tuned or extensively tested.
+          for this feature is already in place. It has not been tuned
+          or extensively tested, however initial experience has given
+          impressive results.
 
 Over the long term, we also wish to provide support to developers who
 wish to extend PSPP with new statistical procedures, by supplying the
@@ -111,3 +90,6 @@ following:
           statistical procedures is evolving quickly enough that a
           plug-in model does not make sense.  Over the long term, it
           may make sense to introduce plug-ins.
+
+For any copyright year range specified as YYYY-ZZZZ in this package note
+that the range specifies every single year in that closed interval.