========================= CXrL version SHADOW 2.3 ========================

This file describes what to do when you get the binary distributions. If 
you are building SHADOW from the source code distribution, then please
read INSTALL file before going any further. 

==========================================================================
Installating CXrL SHADOW from binary distribution
==========================================================================

>> TOC:
    REQUIREMENTS
    GETTING BINARY DISTRIBUTION
    UNPACKING AND CONFIGURATION
	Unix
	Windows'95/NT
    GETTING STARTED
    TROUBLE SHOOTING
    CONTACT
    MAILING LIST

==========================================================================

>> REQUIREMENTS:

- One of the following platforms (yes, you do need a computer :-):

    i[3456]86-cygwin32			(Windows'95/NT + cygwin DLL)
    i[3456]86-linux			(RedHat 4.0+, Debian 1.2+)
    alpha-dec-osf3.2
    hppa1.1-hp-hpux9.07
    rs6000-ibm-aix4.2
    sparc-sun-sunos4.1.3
    sparc-sun-solaris2.4

  Other platforms available on request. You can always grab the source
  code and build it yourself. We will of course gladly help.

- Between 20-40M so disk space for binary installation. Varies according 
  to platform.

- FORTRAN run-time installed on some platforms eg., on rs6000-ibm-aix4.2,
  alpha-dec-osf3.2, etc.

- Internet link and a WEB browser.

- Patience and lots of it

==========================================================================

>> GETTING BINARY DISTRIBUTION:

SHADOW binaries are distributed only via the Internet and not on tapes
and CD-ROMs due to lack of resources.

1. Via WEB: This is the recommended way to get SHADOW source and binary
  distributions from our site. Point your WEB browser to SHADOW home
  page at <http://shadow.xraylith.wisc.edu/shadow> and follow the
  "Download software" link. That should take to the ftp arhive where
  SHADOW lives. The WEB page should also have information on the
  various mirror sites which may be closer to you geographically.

  No password is necessary to access these files, but we do ask that
  you send a note to SHADOW maintainers at shadow@xraylith.wisc.edu
  after you get the binaries.

2. Via FTP:

    server   : shadow.xraylith.wisc.edu
    username : shadow
    password : shadow$94
    directory: shadow/binaries
    files    : shadow-2.3.0-${platform}.tar.gz

3. Via Tape:

    We simply do not have the resources to distribute SHADOW via tapes.
    If you absolutely *cannot* get SHADOW via the Internet, please email
    me and we'll figure something out (I'm not that inflexible :-).

After you get there, you should get the following files:

For Unix (Substitute $platform for whatever platform you need):
   
   - README (this file + some more info)
   - shadow-2.3.0-${platform}.tar.gz
   - shadow-docs.tar.gz
   And if your system does not have GNU unzip (gunzip) to unpack:
   - ../unsupported/gunzip-$platform.Z IF NEEDED

For Windows'95/NT:

   - README (this file + some more info)
   - INSTALL.w95
   - shadow-2.3.0-win32.zip
   - shadow-docs.tar.zip


==========================================================================

>> UNPACKING AND CONFIGURATION:

>>>> Unix:

All the binaries are tar'd and GNU zip'd (hence the .tar.gz extension).
If you do not have "gunzip", then you can get the pre-built binaries
from our FTP site (../unsupported directory) or build it yourself from
the source code available at any fine GNU mirror (eg., PREP at MIT
ftp://prep.ai.mit.edu/pub/gnu). 

Unpacking instructions:
   % mkdir /usr/local/shadow
   % cd /usr/local/shadow
   % gunzip -c /tmp/shadow-2.3.0-i386-linux.tar.gz | tar xvf -
   % gunzip -c /tmp/shadow-docs.tar.gz | tar xvf -

You should now see a directory tree that looks like the following:

    ./.shadowrc ................ Startup file for CSH users
    ./.shadowrc.sh ............. Startup file for sh/bash/ksh users
    ./NEWS ..................... What's new
    ./README ................... This file
    ./SHADOW_VERSION ........... SHADOW version information
    ./SHADOW_GUI_VERSION ....... SHADOW GUI version information
    ./bin/ ..................... All SHADOW binaries
    ./data/ .................... SHADOW data files (mostly binary)
    ./doc/ ..................... Documentation (precious little)
    ./lib/ ..................... Mostly shared libraries you might not have
	./tcl/ ................. GUI (tcl/tk etc) scripts
    ./libexec/ ................. GUI library executables


If you cannot or do not want to install in /usr/local/shadow, then
you will have to edit the two SHADOW startup files located at the top
of the tree (.shadowrc for csh/tcsh users and .shadowrc.sh for Bourne
or Korn shell users) and edit the SHADOW_ROOT variable.


>>>> Windows'95/NT:

All the binaries are zipped with PkZip and you must unpack with a 
compatible unzipper that understands long file names (or else you
lose!). WinZip 6.2 (http://www.winzip.com) is such a compatible
and a very competent program.

Unpacking instructions:
   C:\> mkdir c:\Programs
   C:\> cd \Programs
   C:\> pkunzip -d c:\windows\temp\shadow-2.3.0-win32.zip
   C:\> pkunzip -d c:\windows\temp\shadow-docs.zip

You should now see a directory tree that looks like the following:

    shvars.bat................ Startup file for COMMND.COM
    NEWS ..................... What's new
    README ................... This file
    INSTALL.w95 .............. More on installing Windows'95
    SHADOW_VERSION ........... SHADOW version information
    SHADOW_GUI_VERSION ....... SHADOW GUI version information
    bin\ ..................... All SHADOW binaries
    data\ .................... SHADOW data files (mostly binary)
    doc\ ..................... Documentation (precious little)
    lib\ ..................... Mostly shared libraries you might not have
	\tcl\ ................ GUI (tcl/tk etc) scripts
    libexec\ ................. GUI library executables


In C:\Programs\shadow, you will find "shvars.bat", which contains all
the DOS variables and PATH statements that you will need to run SHADOW
properly. Please inspect this file and make the appropriate changes to
SHADOW_ROOT and PATH statement (leaving the slashes the way they are!)
if you installed to somewhere other than the default c:\Programs\shadow.
Please also insert the following in your AUTOEXEC.BAT file and reboot to 
start using SHADOW:
    
    REM == 
    REM SHADOW startup variables.
    REM ==

    CALL C:\Programs\shadow\shvars.bat

    REM == 
    REM SHADOW startup variables.
    REM ==


==========================================================================

>> GETTING STARTED

>>>> Unix:

- To run SHADOW, users MUST include $SHADOW_ROOT/bin in their $PATH 
  variable, and set a few, one of which is essential, environment 
  variables. The file $SHADOW_ROOT/.shadowrc does this for you (see
  $SHADOW_ROOT/.shadowrc.sh for ksh/bash/sh users).

  Do make sure that the SHADOW_ROOT variable in both of these startup
  files is pointing to the correct SHADOW installation directory. 

- initialize the environment. For CSH users, 
    
  % source /usr/local/shadow/.shadowrc

  does the job. BOURNE shell users use
  
  % . /usr/local/shadow/.shadowrc.sh

- users may wish to read $SHADOW_ROOT/doc/Startup.doc before getting
  started.  

- To run the GUI,
  
  % shadow 

  And load the demos using HELP | DEMOS from the toplevel menu bar.

>>>> Windows'95/NT:

- To run SHADOW, users MUST include %SHADOW_ROOT%\bin in their DOS
  PATH, and set a few, one of which is essential, DOS environment 
  variables. The file %SHADOW_ROOT%\shvars.bat does this for you.

  Do make sure that the SHADOW_ROOT variable in shvars.bat before
  starting out.

- initialize the environment. From a DOS window,
    
  C:\> CALL C:\Programs\shadow\shvars.bat

  If you get "Out of environment errors" (not a problem on NT from what
  I understand, only on Windows'95), put this in your AUTOEXEC.BAT file
  and reboot as explained in the "UNPACKING AND CONFIGURATION" section.

- users may wish to read %SHADOW_ROOT%\doc\Startup.doc before getting
  started.  

- To run the GUI, 
  
  C:\> shadow 

  And load the demos using HELP | DEMOS from the toplevel menu bar.

  [Note that our GUI and the rest of SHADOW prefers Unix-like forward 
  slashes to DOS-like backward ones. This is related to escape sequences 
  used in C and other languages]

==========================================================================

>> TROUBLE SHOOTING:

Troubles, contact CXrL at shadow@xraylith.wisc.edu
                          or phone (608) 877-2400
                          or fax   (608) 877-2401

Please see SHADOW Web page at http://shadow.xraylith.wisc.edu/shadow on
what information you should supply when filing a bug report.

>>>> Unix:

Please double check that the SHADOW_ROOT variable is pointing to the
actual installation directory before looking further.


>>>> Windows'95/NT:

Please double check that the SHADOW_ROOT variable is pointing to the
actual installation directory before looking further.

For more detailed info, see the file PLATFORMS in the source distribution.

==========================================================================

>> CONTACT:

For more information on SHADOW, please contact Mumit Khan at
+1 608 265 6075 <khan@xraylith.wisc.edu> or Franco Cerrina at 
+1 608 263 4955 <cerrina@xraylith.wisc.edu>.

Center for X-ray Lithography
University of Wisconsin - Madison
1415 Engineering Drive
Madison WI 53706

==========================================================================

>> MAILING LIST:

There is also a mailing list for SHADOW users. To join, send a
mail to majordomo@xraylith.wisc.edu with "subscribe shadow-users"
in the body of the message. More info at the SHADOW Web site:

    http://shadow.xraylith.wisc.edu/shadow


#############

Last Updated Fri Apr 11 22:24:13 1997 Mumit Khan <khan@xraylith.wisc.edu>

############

		        ------- x --------
