TUNES Installation mini-HOWTO
Franois-Ren Rideau <fare@tunes.org>
INSTALL,v 1.7 2002/02/22 15:07:42 fare Exp


INSTALLING DEVELOPMENT TOOLS:
See summaries at end of document.


GETTING THE ARCHIVE:
There will be two methods. Both will create a tunes/ directory
with the TUNES sources below.

1) using a .tar.bz2 archive.
  You may get one from various ways.
  One is to point your browser or ftp client to:
	ftp://ftp.tunes.org/pub/tunes/
	ftp://ftp2.tunes.org/pub/tunes/
  and get latest nightly snapshot from snapshot/
  or a "stable" release from release/
  then you can unpack the archive with
	bzip2 -d < tunes-VERSION.tar.bz2 | tar -xf -
  
2) using CVS
  We will be setting up an anonymous CVS server.
  It will be something like:
  a) make sure you have a recent CVS client
  b) log into the server for the first time with
	cvs -d :pserver:cvs@cvs.tunes.org:/cvsroot login
     (at the password prompt type "cvs").
  c) when you wish to check something out, for instance the whole tunes thing:
	cvs -d :pserver:cvs@cvs.tunes.org:/cvsroot co linux
  d) to update the tree to the latest version just cd to the directory
    you want to update and run
	cvs update -d
  e) All normal cvs commands should work. See your cvs manual for details.
  f) For those of you behind firewalls, you will need access to TCP port
    2401 on cvs.tunes.org from your machine.


CONFIGURING:
If you have any special paths to set, edit your ~/.tunesrc from a copy
of the sample found in tunes/bin/tunesrc.bespin to suit your needs.
Then create the directories indicated in your ~/.tunesrc:
	. ~/.tunesrc && mkdir -p $WWW $TUNES $TMP $BACKUPDIR
Then, cd to the tunes/ directory and type:
	make config
If you have any further refinements, edit the file tunes/config.sh
If your system was not recognized, you can try to add support for it
in tunes/bin/autoconf.zsh (and possibly the rest of Tunes).


COMPILING:
Tunes does not currently run and there's not much to build,
besides documentation, so this is really for a later, happier time...
	make


INSTALLING:
	make -k install


TRYING EXAMPLES:
- have the system ready
- launch it with the examples and demos in the demo/ directory


KNOWING MORE ABOUT TUNES:
- point your browser to http://tunes.org, which has the latest information.
- read the archives of the TUNES mailing lists; ask questions there:
	http://lists.tunes.org/cgi-bin/wilma
- you may recreate the documentation from your archive and read it;
 the default location will be tunes/html


UNDERSTANDING THE PROJECT DIRECTORY STRUCTURE:
- bin/				the executable files and system images
- demo/				demonstration files for TUNES (not yet)
- src/				the source tree for the system

Every directory should contain a file named README
that describes the contents of the directory.


SUMMARY OF TOOLS NEEDED TO INSTALL TUNES:
- A free Unix operating system. We use Linux/i386, but feel free
 to add support for your favorite flavor and architecture.
- GNU tar and gzip for archiving and compression
- Julian Seward's BZip2 for better compression.
- CVS to get the latest development archive.
- GNU make
- ZSH for shell scripts
- GNU fileutils, GNU textutils for shell scripts
- sgml-tools to format SGML documents
- A Scheme interpreter/compiler, preferrably one of the supported ones
 (we use GUILE from GNU) to run the programs.
- GCC and GNU binutils to compile the C stuff output by Scheme sources
- perhaps GNU sed and perl for source-level hacks
- LaTeX for converting papers to printable format
- HeVeA for converting papers to HTML

SUMMARY OF TOOLS NEEDED TO DEVELOP TUNES:
- all the above
- perl and sed for lots of small hacks
- GNU patch, GNU diff to manage patches
- procmail if you want automated servicing of official patches.

SUMMARY OF PLACES WHERE TO FIND SOURCES FOR THESE TOOLS
- ftp://metalab.unc.edu/pub/Linux for most everything
- ftp://ftp.gnu.org/pub/gnu for all GNU utilities
- http://www.zsh.org/ for sources for ZSH
- http://www.sgmltools.org/ for sgmltools
- http://www.cyclic.com/ for CVS
- http://sources.redhat.com/bzip2/ for BZip2
- http://www.schemers.org/ for all Scheme-related software
- http://www.latex-project.org/ for LaTeX
- http://pauillac.inria.fr/~maranget/hevea/index.html for HeVeA
