head     1.2;
branch   ;
access   billh dalke;
symbols  ;
locks    ; strict;
comment  @# @;


1.2
date     95.01.09.20.09.31;  author billh;  state Exp;
branches ;
next     1.1;

1.1
date     94.11.27.22.17.58;  author billh;  state Exp;
branches ;
next     ;


desc
@README for use in distribution to other users.
@


1.2
log
@Updated due to changes in how documentation is set up.
@
text
@General README for vmd installation; last modified 1/9/95

VMD is a molecular graphics program designed for ease of use, modifiability,
and modularity.  It runs on Silicon Graphics workstations and may be compiled
for HP-UX workstations if the NPGL library is available.  The latest version
may be obtained via anonymous ftp from ftp.ks.uiuc.edu, in the directory
pub/mdscope/vmd.
 
Documentation: The LaTeX source and generated .dvi file for the vmd manual are
located in the 'doc' directory.  If you do not have LaTeX or a dvi viewer on
your system, the file vmd.ps is a postscript version of the complete manual.
This manual includes three documents, which are also formatted as separate
postscript files:
	1) An installation guide (ig.ps)
	2) A users guide (ug.ps)
	3) A programmers guide (pg.ps)

Installation: Instructions for installing this version of vmd can be found 
in the installation guide, doc/ig.ps.  For a quick installation,
do the following:

	1) uncompress and untar the distribution into a working directory.
In this working directory, there are several subdirectories
bin, src, doc, data, as well as this README and a configure script.  Change to
this working directory after the unpacking is complete.

	2) Edit the file 'configure.parameters'; change the value for
the INSTALLLIBDIR to a directory in which vmd data files and executables should
be installed, and change the value for INSTALLBINDIR to a directory where the
utility programs and startup script should be placed (INSTALLBINDIR should be a
directory in the path of users interested in running vmd).

A) **********  IF YOU ARE INSTALLING VMD FOR SGI IRIX version 5.X  ***********

The distribution includes a precompiled version of VMD for IRIX 5.X, which
will run only on Silicon Graphics workstations with IRIX 5.X or later installed.
If this is the case, follow the next steps, otherwise skip to point B) below.

	3) Generate a Makefile to be used to install vmd by entering the
command:
		configure

	4) change to the 'src' directory, and enter the command:
		make install
	
	5) When installed, type 'vmd' to start.


B) **** IF YOU ARE INSTALLING VMD FOR SGI IRIX version 4.X, or HP-UX 9.X ****

VMD must be compiled before installation; to do so, follow these steps:

	3) The proper Makefile must be generated for your architecture and
preferred options.  For now, run the configure script with these options, based
on the type of OS being used:
	for IRIX 4.X:  configure IRIX4 UNC FORMS OPTIMIZE
	for IRIX 5.X:  configure IRIX5 UNC FORMS CAVE REMOTE OPTIMIZE
	for HPUX 9.X:  configure HPUX9 FORMS OPTIMIZE
	               (Note: To run on HPUX, the NPGL library
				from Portable Graphics must be installed
				in /usr/local/npgl, to provide a version
				of the GL library used for the graphics.)

	4) After configuration is complete, cd to the src directory,
and type 'make depend; make'.  This will compile the program into an executable
'vmd_<architecture>'

	5) After compilation is finished, enter the command:
		make install

	6) When installed, type 'vmd' to start.


For problems and questions, send e-mail to 'vmd@@ks.uiuc.edu'.

				Bill Humphrey and Andrew Dalke
				Theoretical Biophysics Group
				University of Illinois and Beckman Institute
				405 N. Matthews
				Urbana, IL  61801
@


1.1
log
@Initial revision
@
text
@d1 1
a1 1
General README for vmd installation; last modified 11/27/94
d3 6
d11 6
a16 4
your system, the file vmd.ps.Z is a postscript version of the manual.  There
are two documents, a users guide for people interested in using this program
as provided, and a programmers guide which describes the structure of this
package and hints on making modifications.
d19 1
a19 1
in the vmd manual, which is in the 'doc' directory.  For a quick installation, 
d22 2
a23 3
	1) uncompress and untar the distribution into a working directory

	2) in this working directory, there are several subdirectories
d27 26
d54 6
a59 6
preferred options.  For now, run the configure script with these options:
	configure <architecture> FORMS OPTIMIZE
where <architecture> is one of the following:
		IRIX4	- SGI Irix 4.X
		IRIX5	- SGI Irix 5.X
		HPUX9	- HPUX 9.X (Note: To run on HPUX, the NPGL library
d65 1
a65 1
and type 'make'.  This will compile the program into an executable
d68 2
a69 5
	5) After compilation is finished, install the program and utility
files into the directory you wish.  By default the distribution is set up
to install utility scripts in '/usr/local/bin', and other files needed by
vmd in '/usr/local/lib/vmd'.  See the documentation on how to change these
settings.
d73 8
@
