   Project S.W.O.R.D
   V2.10

   SubSystem : Documentation
   File      : Docs/Readme.1st
   Author    : Eric NICOLAS
   Overview  : Informations : Starting with Sword
   UpDate    : 2005 Florian Xaver

** Copyright (C) 1993-1996 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

    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 either
    versions djgpp1.12maint4 and libgrx1.03 or versions djgpp2 and
    libgrx20. 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:\SAMPLES\DIALOG     Dialog box application sample
         C:\SAMPLES\IMAGE      Image application sample
         C:\SAMPLES\MANDEL     Mandelbrot fractal 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 MS-Word 7 file.
                               Subdirectories of \DOCS\ChapXX includes source files
                               for examples in the documentation.
         C:\SWORD\FONTS        The necessary fonts for SWORD. If you have libgrx installed
                               somewhere else, you can just delete this directory
                               because you already have thoses files.

         !!!! Please note that only DJGPP V2 binaries can be executed without installing the
         !!!! compiler and the libgrx.

         !! If you are using DJGPP V2, you can use envdj2.bat. But you must edit it !!

         1a. When using DJGPP V2, Setup the following environment variables :
              SET GRX20DRV=driver
              SET GRXFONT=C:/SWORD/FONTS
            With driver in [STDVGA, STDEGA, ET4000, CL5426, MACH64, ATI28800, VESA].

         1b. When using TURBOC Setup the following environment variables :
              SET GRXDRV=path_to_driver_for_turboc
              SET GRXFONT=path_to_fonts
              SET GO32=path_to_driver_for_djgpp

         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 V2, but You can recompile
            the demo programs with TC or DJGPP V2 :
             . Compile with TC    : Use .PRJ file in their directory,
                                    just change the Options/Directory in
                                    TurboC IDE.
             . Compile with DJGPP : In C:\SWORD, copy the right makefile definitions to make.def. For
                                    example, if you compile with DJGPP V2, copy djgpp_v2.def into make.def.
                                    Go into C:\SWORD\SAMPLES directory
                                    and run MAKE

    5. The author
    -------------

        I wrote most part of the code during my free time. You can contact
        me by E-Mail at :
                enicolas@dvdfr.com
        or by Post-Mail at :
                Eric NICOLAS
                11 Allee du Parc Pompidou
                38100 GRENOBLE
                FRANCE

        If you use SWORD, or if you appreciated it, you can of course send
        me some reward (PostCard, nice letter or mail, money...).

        You are also encouraged to report bugs and to make any comments.

        > IMPORTANT (but private) :
        >
        > I am also looking for a job in the area of computer Graphics/GUI (or
        > anything that touch programming, mainly in C/C++, on DOS/Windows/UNIX).
        > I will study all offers, in France of course, but also in Europe
        > (Preferably England), and in the US. Thanks.
        > I will be discharged of my current activities at the begining of
        > september 1996.


    6. The End
    ----------

        That's all folks !
        For more informations, take a look at SWORD.DOC (Word 6/7 file) or SWORD.PS (PostScript).

        Have a nice moment with Sword... ;-)
