   Project SùWùOùRùD
   V2.0

   SubSystem : Documentation
   File      : Docs/Readme.1st
   Author    : Eric NICOLAS
   Overview  : Informations : Starting with Sword
   UpDate    : Nov 20, 1995

** Copyright (C) 1993,1995 The SWORD Group
**
** This file is distributed under the terms listed in the document
** "copying.en". A copy of "copying.en" should accompany this file.
** if not, a copy should be available from where this file was obtained.
** This file may not be distributed without a verbatim copy of "copying.en".
**
** This file is distributed WITHOUT ANY WARRANTY; without even the implied
** warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


   1. What is SùWùOùRùD ?
   ----------------------

         SWORD means System of Windows for the ORganisation of the Desktop.
         It is a Graphic User Interface (GUI) made with C++ objects, and
    it is accessible with Turbo C++ and GNU C++ (djgpp).
         It provides to the programmer all objects that are necessary to
    implement a nice and intuitive GUI. With Sword, all your programs will
    look as nice as NeXT interface. Thanks to object oriented programming,
    this interface is very easy to programm.
         The basic concepts behind the objects in SWORD are :
         -> Linked lists (or in fact linked trees)
         -> Events mecanism
         -> Efficient way of managing overlapping windows

    2. What will you find in SùWùOùRùD ?
    ------------------------------------

         All classical features of any GUI will be available in SWORD. So
    you will find objects to create :
         -> Windows, Dialogs
         -> Buttons, Check boxes, Radio buttons
         -> Text Edition controls, Static text
         -> Menus
         -> A full mathematical library including matrixes, vectors and
            so on, in a convenient object-oriented implementation.
         -> And many other objects

         At this moment, the project is beginning and you will NOT find
    Text edition controls or standard dialogs such as File Dialogs.

    3. What do you need to use SùWùOùRùD ?
    --------------------------------------

         You can use Sword library with both Turbo C++ and djgpp compilers.
         In both cases, you will need all the files in this package, plus
    the extended graphic library for djgpp (libgrx).
         -> With Turbo C, a 386sx16, 1Mo is sufficient. You will only be
            able to use the standard 640x480x16 graphic mode. Of course,
            a much powerfull computer is recommended to program new
            applications using Sword.
         -> With GNU C (djgpp), a 386dx20, 4Mo is a minimum. You will be
            able to use all graphics mode of your graphic card, if you have
            the good driver.
         A mouse is necessary to pilot the graphic interface.
         If you want to use SWORD with djgpp, you must have v1.12maint4
    (last official release). You can upgrade your djgpp system from any
    SimTel mirror if necessary.

    4. Installation instructions
    ----------------------------

         If all the file have been expanded normally, you should have
    the following directories :
         C:\SWORD\             The main directory where you expand Sword files
                               Contain also some usefull files and the SETUP.EXE
         C:\SWORD\INCLUDE      Include files for the library
         C:\SAMPLES            Samples programs
         C:\SAMPLES\MINI_APP   Minimal application sample
         C:\SAMPLES\HELLO      Hello application sample
         C:\SWORD\SRC          Source files for the library
         C:\SWORD\LIB          .A and .LIB files for the library
         C:\SWORD\TOOLS        Some little utilities apart from the library
         C:\SWORD\TOOLS\SETUP  Configuration program source code
         C:\SWORD\TOOLS\COLORS Computation of the colors tables. DO NOT USE.
         C:\SWORD\DOCS         Documentations. Including this file.
                               !! The Sword.DOC file is a WinWord V2 file in
                                  FRENCH and is NOT yet updated to reflect the
                                  last modifications in the library.

         1. Be sure you have the next environnement variables :
              SET GO32= (...) driver path_driver/stdvga.grn (...)
              SET GRXFONT=path_to_grx_fonts

         2. Set the next environnement variable :
             SET SWORDPATH=C:\SWORD

         3. Execute the C:\SWORD\SETUP program and follow the instructions in
            order to choose a screen configuration according to your graphic
            card capabilities.

         4. Try the demo programs :
            You will find demo programs in subdirectories of C:\SWORD\SAMPLES.
            Those programs have been compiled with DJGPP. If you don't have this
            compiler, you will not be able to run them. You can recompile the
            demo progrms with TC, or even with DJGPP :
             . Compile with TC    : Use .PRJ file in their directory,
                                    just change the Options/Directory in
                                    TurboC IDE.
             . Compile with DJGPP : Go into C:\SWORD\SAMPLES directory
                                    and run MAKE
            !! DJGPP demo progams will not run in a Windows DOS-Box because
               DJGPP v1.12maint4 compiler don't support graphics in full
               DPMI mode.

              If you have a problem with linking, it is due to libgrx.a
              wich is buggy in v1.12m4. Correct this by compiling mouse.c
              of libgrx and by replacing the old mouse.o by your new
              mouse.o in the libgrx.a (see djgpp FAQs).

        All comments, suggestion, bugs can be reported to :
            nicolas@dsys.ceng.cea.fr

        Have a nice moment with Sword... ;)

