[lmi-commits] [5115] Improve documentation

[Greg Chicares]

Revision: 5115
          http://svn.sv.gnu.org/viewvc/?view=rev&root=lmi&revision=5115
Author:   chicares
Date:     2010-11-02 01:50:22 +0000 (Tue, 02 Nov 2010)
Log Message:
-----------
Improve documentation

Modified Paths:
--------------
    lmi/trunk/ChangeLog
    lmi/trunk/INSTALL
    lmi/trunk/test_coding_rules.cpp

Modified: lmi/trunk/ChangeLog
===================================================================
--- lmi/trunk/ChangeLog 2010-11-01 22:04:19 UTC (rev 5114)
+++ lmi/trunk/ChangeLog 2010-11-02 01:50:22 UTC (rev 5115)
@@ -26853,3 +26853,9 @@
   install_msw.sh
 Prefer svn to cvs.
 
+20101102T0150Z <address@hidden> [656]
+
+  INSTALL
+  test_coding_rules.cpp
+Improve documentation.
+

Modified: lmi/trunk/INSTALL
===================================================================
--- lmi/trunk/INSTALL   2010-11-01 22:04:19 UTC (rev 5114)
+++ lmi/trunk/INSTALL   2010-11-02 01:50:22 UTC (rev 5115)
@@ -21,13 +21,112 @@
 
 // $Id$
 
-* Platform: GNU/Linux
-
-See:
+[Just go here:
   http://lists.nongnu.org/archive/html/lmi/2008-05/msg00001.html
+if you're not running ms windows.]
 
-* Platform: msw
+(1) Install Cygwin
 
-See:
-  http://lists.nongnu.org/archive/html/lmi/2007-12/msg00002.html
+Open a "Command Prompt" window, and enable pasting into it:
 
+  Start | Programs | Accessories | Command Prompt
+  alt-Spacebar | Properties | Options
+  check both "QuickEdit Mode" and "Insert Mode"
+  OK
+  select "Modify shortcut that started this window"
+  OK
+
+Copy and paste the following lines into the "Command Prompt" window:
+
+  C:
+  mkdir C:\cache_for_lmi
+
+Save the following three files into the 'C:\cache_for_lmi' directory:
+
+  http://www.cygwin.com/setup-legacy.exe
+  http://www.cygwin.com/setup.exe
+  http://svn.sv.nongnu.org/svn/lmi/lmi/trunk/install_cygwin.bat
+
+Copy and paste the following lines into the "Command prompt" window:
+
+  cd C:\cache_for_lmi
+  install_cygwin >installed.txt
+
+A messagebox warns:
+
+  Attempt to install legacy version of Cygwin
+  ---------------------------
+  You are attempting to install a legacy version of Cygwin
+  on a modern version of Windows.  Press "OK" if this is
+  really want you want to do.  Otherwise press "Cancel".
+  See http://cygwin.com/ for more information.
+
+It may appear several times; press "OK" each time. When it finishes,
+copy and paste the following line into the "Command prompt" window:
+
+  type installed.txt
+
+You should see something like this:
+
+  "Anomalous 'C:\cygwin' directory present after iteration" 1
+  "Anomalous 'C:\cygwin' directory present after iteration" 2
+  "Cygwin 1.5 installation seems to have succeeded on iteration" 3
+  "Cygwin 1.7 installation seems to have succeeded"
+
+Close the "Command prompt" window.
+
+(2) Configure Cygwin
+
+Start 'bash', and enable pasting:
+
+  Start | Programs | Cygwin | Cygwin Bash Shell
+  alt-Spacebar | Properties | Options
+  check both "QuickEdit Mode" and "Insert Mode"
+  OK
+  select "Modify shortcut that started this window"
+  OK
+
+Copy and paste the following lines into 'bash':
+
+  cd /etc
+  echo '#' >> fstab
+  echo 'C:/opt/lmi/MinGW-20090203 /MinGW_  lmi_specific binary,user 0 0' >> 
fstab
+  echo 'C:/opt/lmi                /opt/lmi lmi_specific binary,user 0 0' >> 
fstab
+  echo 'C:/lmi                    /lmi     lmi_specific binary,user 0 0' >> 
fstab
+
+Close the 'bash' window to make these settings take effect.
+
+(3) Install lmi
+
+Start 'bash':
+
+  Start | Programs | Cygwin | Cygwin Bash Shell
+
+Copy and paste the following into 'bash':
+
+  mkdir -p /tmp
+  export TMP=/tmp
+  install_script='http://svn.sv.nongnu.org/svn/lmi/lmi/trunk/install_msw.sh'
+  cd /tmp
+  wget -N $install_script
+  chmod +x install_msw.sh
+  logfile=log-`date -u +'%Y%m%dT%H%MZ'`; echo "Log file is '$logfile.tar.bz2'."
+  ./install_msw.sh >$logfile 2>&1; tar -cjf $logfile.tar.bz2 $logfile
+
+Installation proceeds silently for about an hour. When you see
+"Finished building lmi", copy and paste these lines into 'bash':
+
+  export PATH=/opt/lmi/local/bin:/opt/lmi/local/lib:$PATH
+  cd /opt/lmi/bin; ./lmi_wx_shared --data_path=/opt/lmi/data
+
+You should see lmi's GUI. Try "File | New | Illustration", then press
+"OK"; you should see values. Then try "File | Print preview". You
+should see an illustration in your 'pdf' viewer. But if you see
+  'java' is not recognized as an internal or external command,
+  operable program or batch file
+then (for printing only) you need 'java'. You can get a version
+that's been tested with lmi here:
+  http://java.sun.com/products/archive/j2se/1.4.2_06/index.html
+Click "Download J2RE", then download and run this file:
+  j2re-1_4_2_06-windows-i586-p.exe
+

Modified: lmi/trunk/test_coding_rules.cpp
===================================================================
--- lmi/trunk/test_coding_rules.cpp     2010-11-01 22:04:19 UTC (rev 5114)
+++ lmi/trunk/test_coding_rules.cpp     2010-11-02 01:50:22 UTC (rev 5115)
@@ -895,6 +895,7 @@
     if
         (   !f.is_of_phylum(e_log)
         &&  !f.is_of_phylum(e_make)
+        &&  !f.is_of_phylum(e_synopsis)
         )
         {
         taboo(f, "\\bexe\\b", boost::regex::icase);