# ***************************************************************************
#                          NCLEVER version 4.0
#
#                 Copyright (C) 1994-1999 by Pierre Rioux
#                 Organelle Genome Megasequencing Project,
#                       Departement de Biochimie,
#                        Universite de Montreal,
#                        C.P. 6128, succursale A,
#                           Montreal, Quebec,
#                            Canada, H3C 2J7
#
#                 And by William A. Gilbert, Department of
#                Biochemistry, University of New Hampshire
#                        Durham, NH, USA 03824-3554
#                         E-Mail: gilbert@unh.edu
#
#                   Tim Littlejohn (Project Management) 
#
#               E-Mail information: ogmp@bch.umontreal.ca
#
#     This software is distributed under the GNU GENERAL PUBLIC LICENSE, as
# published by the Free Software Foundation. A copy of version 2 of this
# license should be included in a file called COPYING. If not, write to the
# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
# ***************************************************************************

    This file is a very rough draft on how to compile and install nclever

A sample Makefile is provided for reference.  This Makefile was used to 
compile nclever with gcc on a Sun SPARCStation running Solaris 2.6.

    Step 1- Compile and install the NCBI toolkit.
            The toolkit is available by anonymous FTP to ncbi.nlm.nih.gov
            in the "toolbox/ncbi_tools" directory. The file is called
            "ncbi.tar.Z" for UNIX systems, "ncbiZ.exe" for DOS machines
            and "ncbi.sea.hqx" for MacIntoshes.

    Step 2- Compile all four .c files used to make nclever:

            main.c    lists.c    print.c    entinfo.c

            They #include a file called "main.h". Use an ANSI-C compiler,
            such as the GNU "gcc" compiler.

    Step 3- Link the produced object files (main.o, lists.o and print.o)
            with the appropriate toolkit libraries:

              -lncbiNacc -lnetentr -lncbicdr -lncbiobj -lnetcli -lncbi

            along with some system libraries: (example for Solaris:)

              -lm -lsocket -lnsl -lxnet

    Step 4- At this point you can simply run the executable; it used to be
            necessary to install a correctly configured ".ncbirc" file,
            but as of January 1999 this is not required anymore since
            nclever will get all the needed information through the network.
            For completeness, and in case it is useful for debugging an
            installation, here is the text of "Step 4" as it was distributed
            with previous version of nclever:

                /* Start of obsolete installation instruction */
                      Make sure you have a valid .ncbirc file
                      available; an example .ncbirc file is provided
                      (called "ncbirc").
                      - The DATA= field must supply a legal path to
                        the files in the data/ subdirectory of the
                        NCBI toolkit.
                      - The ASNLOAD= field must supply a legal path
                        to the files in the asnload/ subdirectory of
                        the NCBI toolkit.
                /* End of obsolete installation instruction */

    Step 5- About UNIX printing (with nclever's "print" command): nclever
            needs to know which command to use in order to print.
            This can be configured by adding to you .cleverrc file
            the following two lines:
                [PRINT]
                COMMAND=lp
            (Both lines fully left-justified of course). The UNIX COMMAND
            will be execute with a single argument, the name of a temporary
            file created in "/var/tmp/".

    Pierre Rioux
    Tim Littlejohn
    OGMP, May 1994, ogmp@bch.umontreal.ca
    Revised: February 1999
