This file describes the contents of the distribution for TeXdraw.

$Id: README,v 2.0a 2019/03/28 texdraw-V2R0a $

The TeXdraw package consists of a set of macro definitions for the TeX
typesetting program.  These macros allow the user to produce PostScript
drawings from within TeX and LaTeX.

The main benefits of TeXdraw accrue from the ability to produce drawings
from <within> TeX, using TeX fonts for labelling the drawing.

Basic drawing features include:
(1) moves, lines and arrow vectors
    - selectable gray level, line width pattern, arrowhead size and type
(2) circles, ellipses, arcs, and Bezier curves
(3) general fill command to fill a region defined by lines and Bezier
    curves (selectable gray level)
(4) TeX text, including mathematics, can be positioned and superimposed
    on the drawing

TeXdraw has been designed to be extensible.  Drawing "segments" are
relocatable, self-contained units.  Using a combination of the begingroup/
endgroup mechanism in TeX and the gsave/grestore mechanism in PostScript,
drawing segments allow for local changes to the scaling and line
parameters.  Using TeX's macro definition capability, new drawing commands
can be constructed from drawing segments.

The extensibility features include,
(1) relocatable drawing segments to keep changes local
(2) local segment scaling
(3) saving and restoring positions using symbolic positions

Version 2.0a was rleased in March 2019; the only substantive
modification was to change the license to CC-BY (any version).
Also, an Info direntry is created by texdraw.texi, and
minor changes were made to this README and other documentation files.
For the distribution:
- A PDF version of the manual was added.
- the Texinfo source files (texindex.c, texi2dvi, etc.) were removed, as
they are readily available elsewhere and cannot be kept up to date here.

=====
Peter Kabal                            peter dot kabal at mcgill dot ca
Department of Electrical Engineering
McGill University
Montreal, Quebec


=====
The distribution consists of the TeXdraw macros themselves, files with
auxiliary macros, and the TeXdraw manual (Texinfo format).

Distribution Contents:
----------------------

Miscellaneous:
  README              - this file
  ChangeLog           - log of changes to TeXdraw

TeXdraw macros (main directory):
  texdraw.tex         - TeXdraw macros for TeX
  texdraw.sty         - LaTeX2e interface to TeXdraw
  txdtools.tex        - TeXdraw toolbox for extending TeXdraw
  txdps.tex           - TeXdraw macros for accessing PostScript macros
  blockdiagram.tex    - Block diagram macros for TeXdraw
  txdexamp.tex        - plain TeX code for the examples in the manual
  txdexamp.latex      - LaTeX2e code for the examples in the manual

TeXdraw documentation (directory manual/):
  texdraw.pdf         - PDF version of the manual
  texdraw.ps          - PostScript version of the manual
  texdraw.texi        - Texinfo source file for the TeXdraw manual

===============================================
The following notes on setup are for Unix systems.

Initial Tests:

(1) Print the PostScript version of the manual ("texdraw.ps") to see the
    capabilities of TeXdraw. (Or PDF.)
(2) Try TeX'ing the examples file.  Assuming plain TeX is invoked with the
    command "tex" and LaTeX2e is invoked with the command "latex"
    % tex txdexamp
    ... or ...
    % latex texdexamp.latex
(3) Printing the examples using the appropriate printer driver program (only
    dvips can be used with the plain TeX version of the examples),
    % dvips txdexamp

=====
Permanent Setup:

(1) Private copy of TeXdraw.
    Move the TeXdraw sources files ("texdraw.sty", texdraw.tex",
    "txdtools.tex" and "txdps.tex") to an appropriate directory.  If you are
    keeping private versions of the files, consider using the directory
    ~mylogin/tex . With many versions of TeX, including this directory in
    the TeX input path variable (the environment variable TEXINPUTS) allows
    you to refer to the files in TeX without specifying the full pathname.
    With the C shell, a line in the ".login" file sets the environment
    variable TEXINPUTS
    % setenv TEXINPUTS ".:$HOME/tex:".
    The last part of the path string should terminate with a colon to have
    the default directory of TeX files available.
(2) Public copy of TeXdraw.
    Move the TeXdraw source files ("texdraw.sty", "texdraw.tex",
    "txdtools.tex" and "txdps.tex") to a directory that TeX searches by
    default.  If installed from a distribution, this should be
    handled by the package manager.

=====
Creating a TeXdraw manual from the sources:
(1) Make sure "texdraw.tex", "txdtools.tex" and "texinfo.tex" will be found
    by TeX.
(2) To create the manual, you have to TeX the manual twice - the second
    time to access the sorted indices and the cross-references.  The
    program "texindex" sorts the indices.  (The distribution includes pre-
    sorted indices that can be used).  Or the three steps can be replaced by
    an invocation of the script "texi2dvi".
    % tex texdraw.texinfo
    % texindex texdraw
    % tex texdraw.texinfo
(3) If you have the printer driver program dvips, a PostScript version of the
    manual is created as follows.
    % dvips texdraw -o texdraw.ps
(4) The targets in manual/Makefile handle this.