[nongnu] elpa/gnuplot ae7c4b4 104/184: readme tweaks

[ELPA Syncer]

branch: elpa/gnuplot
commit ae7c4b4b0ac01900aa81cc2a749bfe625d75001f
Author: joddie <jonxfield@gmail.com>
Commit: joddie <jonxfield@gmail.com>

    readme tweaks
---
 INSTALL.org |  44 +++++++++++++++++---------
 README.org  | 102 +++++++++++++++++++++++++-----------------------------------
 2 files changed, 71 insertions(+), 75 deletions(-)

diff --git a/INSTALL.org b/INSTALL.org
index 93299f7..f988ae0 100644
--- a/INSTALL.org
+++ b/INSTALL.org
@@ -8,57 +8,57 @@
 
   Gnuplot-mode has been included with Gnuplot since the 3.7
   distribution. The installation instructions for the free-standing
-  distribution have been modified to be consistent with that. 
-  
+  distribution have been modified to be consistent with that.
+
 ** Normal installation (configure + make)
    1. Type ~./configure~.
 
       If configure doesn't work for you, you can use ~Makefile.dst~
       instead: see [[Installing without configure or make]] below.
-      
+
       You can specify the Emacs executable to use for byte-compiling
       by using the ~EMACS~ environment variable: for example
       ~./configure EMACS=xemacs~ to use XEmacs.  On Mac OS X, if your
       Emacs application is located at ~/Applications/Emacs.app~, you
       should do ~./configure
       EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs~
-      
+
       You can also specify the ~--with-lispdir=~ switch to change
       where ~make install~ will put the compiled Lisp files, for
       example to install them in your ~.emacs.d~ directory.
-      
+
       If you build this from a shell within Emacs itself and get
       strange issues with load paths or environment variables, build
       it in a separate terminal
-      
+
    2. Run ~make~.  There will be some compilation warnings, but they
       should be harmless.
-      
+
    3. To make the reference card, run ~make pdf~ or ~make ps~.
-      
+
    4. Run ~make install~, or manually move the lisp files to the
       system site_lisp directory if you are installing as root. If you
       are installing as a normal user, move the ~.elc~ files to a
       place where emacs can find them, e.g. your personal ~.emacs.d~.
-      
+
 ** Installing without configure or make
    If ~configure~ fails for some reason, you can use the included
    ~Makefile.dst~ file by doing ~make -f Makefile.dst~. This makefile
    doesn't include an install target, so you'll have to install the
    ~.elc~ files manually. It does have targets to build the
    gnuplot-mode reference card (~pdf~, ~ps~ or ~all~).
-   
+
    The "configure; make" sequence may not work on all systems,
    particularly Win32 systems. The long-winded way of making the .elc
    and gpelcard.ps files is to edit each of the .el files with emacs
    and do ~M-x byte-compile-file~. Then ~latex gpelcard.tex~ and
    ~dvips gpelcard.dvi~, or ~pdflatex gpelcard.tex~.
-   
+
 * Post-installation setup
    1. Insert the contents of the ~dotemacs.el~ file into your
       ~.emacs~ or into the system's emacs start-up file to enable
       gnuplot mode.
-      
+
    2. The function ~gnuplot-info-lookup-symbol~ looks at the Gnuplot
       info file that comes with this package or that can be made from
       the Gnuplot distribution.  For that function to work, the file
@@ -66,16 +66,30 @@
       example ~/usr/info~  A line like this in your .emacs allows you to
       put gnuplot.info any place convenient:
       ~(add-to-list 'Info-default-directory-list "/path/to/file")~
-      
+
 * Build-system files
   The included ~configure~, ~aclocal.m4~ and ~Makefile.in~ files were
   generated from ~configure.ac~ and ~Makefile.am~ using GNU autotools
   2.69. If you want to regenerate them for some reason, do the
   following:
-  
+
   : autoreconf
   : automake --add-missing
-  
+
+  The build- and installation-related files are the following:
+
+  | File               | Description                                          |
+  |--------------------+------------------------------------------------------|
+  | configure.ac       | Definitions for `autoconf`                           |
+  | Makefile.am        | Definitions for `automake`                           |
+  | Makefile.dst       | Alternative makefile, avoiding configure & autotools |
+  | dot.el             | a short lisp file used by Makefile.dst               |
+  | configure          | `configure` script generated from configure.ac       |
+  | aclocal.m4         | m4 macros generated from configure.ac                |
+  | Makefile.in        | Makefile template generated from Makefile.am         |
+  | install-sh         | scripts needed by configure and make                 |
+  | missing            |                                                      |
+
 * Problems?
   Contact gnuplot-mode's author Bruce Ravel <bruceravel1@gmail.com> or
   submit an issue on github: http://github.com/bruceravel/gnuplot-mode
diff --git a/README.org b/README.org
index ffc7cea..f382427 100644
--- a/README.org
+++ b/README.org
@@ -1,38 +1,27 @@
 
 * gnuplot-mode, version 0.7
 
-This directory contains files for running Gnuplot from within emacs.
-This package was assembled by Bruce Ravel <bruceravel1@gmail.com>.
-See the homepage at [[http://xafs.org/BruceRavel/GnuplotMode]]
-
+  This directory contains files for running Gnuplot from within emacs.
+  This package was assembled by Bruce Ravel <bruceravel1@gmail.com>.
+  See the homepage at [[http://xafs.org/BruceRavel/GnuplotMode]]
 
 ** Contents
 
-  | File               | Description                                          |
-  |--------------------+------------------------------------------------------|
-  | README.org         | this file                                            |
-  | INSTALL.org        | thorough installation instructions                   |
-  | gnuplot.el         | gnuplot mode for emacs                               |
-  | gnuplot-gui.el     | a GUI for setting command arguments interactively    |
-  | gnuplot-context.el | context-sensitive completion and help lookup         |
-  | gnuplot.info       | info version of gnuplot 4.6 help                     |
-  | gpelcard.tex       | quick reference card for gnuplot mode (latex)        |
-  | dotemacs.el        | example .emacs lines for enabling gnuplot mode       |
-  | configure.ac       | Definitions for `autoconf`                           |
-  | Makefile.am        | Definitions for `automake`                           |
-  | Makefile.dst       | Alternative makefile, avoiding configure & autotools |
-  | dot.el             | a short lisp file used by Makefile.dst               |
-  | configure          | `configure` script generated from configure.ac       |
-  | aclocal.m4         | m4 macros generated from configure.ac                |
-  | Makefile.in        | Makefile template generated from Makefile.am         |
-  | install-sh         | scripts needed by configure and make                 |
-  | missing            |                                                      |
+   | File               | Description                                          
|
+   
|--------------------+------------------------------------------------------|
+   | README.org         | this file                                            
|
+   | INSTALL.org        | thorough installation instructions                   
|
+   | gnuplot.el         | gnuplot mode for emacs                               
|
+   | gnuplot-gui.el     | a GUI for setting command arguments interactively    
|
+   | gnuplot-context.el | context-sensitive completion and help lookup         
|
+   | gnuplot.info       | info version of gnuplot 4.6 help                     
|
+   | gpelcard.tex       | quick reference card for gnuplot mode (latex)        
|
 
 ** Installation
 *** Installing from MELPA
     In recent versions of Emacs, gnuplot-mode can be installed directly
     from the [[http://melpa.milkbox.net][MELPA]] package repository as the 
~gnuplot~ package (note:
-    not ~gnuplot-mode~, which is an alternative gnuplot package). 
+    not ~gnuplot-mode~, which is an alternative gnuplot package).
 
     After [[http://melpa.milkbox.net/#installing][configuring Emacs to use 
MELPA]], you should be able to
     install gnuplot-mode by typing
@@ -54,6 +43,14 @@ See the homepage at 
[[http://xafs.org/BruceRavel/GnuplotMode]]
     See the file INSTALL.org for details.
 
 ** New features for gnuplot-mode 0.7
+   Version 0.7 of gnuplot-mode is designed for use with gnuplot
+   version 4.4 and up. It will also mostly work fine with older
+   versions. If it doesn't work with newer versions, report a bug.
+
+   This version has mostly been tested under GNU Emacs 23 and 24.
+   It should also work on GNU Emacs 22 and XEmacs 21. It may work
+   with earlier versions, but it has not been tested.
+
 *** New syntax for gnuplot version 4
     This version of gnuplot-mode supports the new curly-brace-block
     ~do~ and ~if~ statements introduced in recent versions of gnuplot.
@@ -63,16 +60,23 @@ See the homepage at 
[[http://xafs.org/BruceRavel/GnuplotMode]]
 
 *** Context-sensitive keyword completion
     By default gnuplot-mode will try to parse your commands as you
-    type, so that tab completion via M-TAB or TAB will only suggest
-    relevant completion candidates.  For example, with point after the
-    ~with~ of a ~plot~ command, tab completion will suggest only
-    plotting styles.  This also enables more specific help topic lookup
-    in the gnuplot info file, provided you have the right version of
-    ~gnuplot.info~ installed.
-
-    If the context-sensitivity annoys you, you can get the old behavior
-    back by toggling ~gnuplot-context-sensitive-mode~.  See also the
-    variable ~gnuplot-tab-completion~.
+    type and suggest only relevant completion candidates on typing
+    M-TAB or TAB. For example, with point after the ~with~ of a ~plot~
+    command, tab completion will suggest only plotting styles. This
+    also enables more specific help topic lookup in the gnuplot info
+    file, provided you have the right version of ~gnuplot.info~
+    installed.
+
+    If the context-sensitivity annoys you, you can get simple
+    non-context-sensitive completion back by toggling
+    ~gnuplot-context-sensitive-mode~. See also the variable
+    ~gnuplot-tab-completion~.
+
+    By its nature, the completion code has to know a fair bit about
+    the structure of the gnuplot language. If you use it with an old
+    version of gnuplot (pre version 4) it will make mistakes. Most of
+    gnuplot 4.6's command language is parsed correctly except for the
+    =set terminal= commands.
 
 *** Eldoc mode
     If you install the file ~gnuplot-eldoc.el~ from a recent Gnuplot
@@ -89,29 +93,15 @@ See the homepage at 
[[http://xafs.org/BruceRavel/GnuplotMode]]
     Gnuplot to have ~png~ support and a GNU Emacs with image support.
     Please report bugs.
 
-
 ** NOTES
-
-   1. Version 0.7 of gnuplot-mode is designed for use with gnuplot
-      version 4.4 and up.  It will also mostly work fine with older
-      versions.  If it doesn't work with newer versions, report a bug.
-
-      This version has mostly been tested under GNU Emacs 23 and 24.
-      It should also work on GNU Emacs 22 and XEmacs 21. It may work
-      with earlier versions, but it has not been tested.
-
-   2. If "configure" doesn't work for you, the file "Makefile.dst" can be
-      used.  In that case do, "make -f Makefile.dst" and carry on from
-      there.
-
-   3. The gnuplot-mode distribution comes with the version of the gnuplot
+   1. The gnuplot-mode distribution comes with the version of the gnuplot
       info file that gets made by gnuplot 4.6.  Use it rather than the
       old one.  If you really must use the older info file, see the
       document string for the variable `gnuplot-info-hook'.  If you
       already have the info file installed on your computer, you will not
       need the one that comes with gnuplot-mode.
 
-   4. The interactive graphical graphical interface to setting command
+   2. The interactive graphical graphical interface to setting command
       arguments contained in gnuplot-gui.el is experimental.  It is
       incomplete and may make mistakes.  Hopefully, you will find it
       useful.  It *requires* that you are using a version of emacs with
@@ -120,27 +110,19 @@ See the homepage at 
[[http://xafs.org/BruceRavel/GnuplotMode]]
       with the widget library.  For version numbers in the 19's, it can
       be obtained at [[http://www.dina.kvl.dk/~abraham/custom/]]
 
-   5. By definition, the context sensitive completion has to know a
-      fair bit about the structure of the gnuplot language.  If you use
-      it with an old version of gnuplot (pre version 4) it may make
-      mistakes.  Most of gnuplot 4.6's command language is parsed
-      correctly, with the exception of the various =set terminal=
-      commands.
-
-   6. Gnuplot's ~pause -1~ command, which waits for the user to press a
+   3. Gnuplot's ~pause -1~ command, which waits for the user to press a
       key, is problematic when running under Emacs.  Sending =pause -1=
       to the running gnuplot process will make Emacs appear to freeze.
       (It isn't really crashed: typing =C-g= will unlock it and let you
       continue).  The workaround for now is to make Gnuplot output a
       string before pausing, by doing
-      
+
       #+BEGIN_EXAMPLE
       pause -1 "Hit return"
       #+END_EXAMPLE
 
       or similar.  Thanks to Jim Mehl for reporting this issue.
 
-
 ** The todo list
    1. Use [[http://tromey.com/elpa/][ELPA]]