$Revision:   1.54  $

README.TXT                 Codewright V3.1
==========

  This README.TXT file contains important information about Premia
  Corporation's Codewright.  Read this file in its entirety for the
  latest information regarding this release of Codewright.  
  
  See also the file CW_QA.TXT for answers to commonly asked questions.

  If you are updating from a previous version of Codewright, you will
  find reading the file UPDATE.TXT to be useful.

  --------------------------------------------------------------------

  This file has been divided into the following six sections for easy
  reference:

        1.  GETTING HELP
        2.  INSTALLATION
        3.  LATE CHANGES
        4.  REBUILDING DLLs 
        5.  UNDOCUMENTED API FUNCTIONS  
        6.  HISTORY

  Suggestions for enhancements and constructive criticism are always
  welcome.  We will continue to add new features and functionality
  based on customer feedback.

  Be sure to register.  This is our only way to validate your
  purchase and notify you of future releases.  It will also allow you
  to access areas on our BBS not available to unregistered users.

  If you are part of a development team or if there are other
  developers at your company that need Codewright, please call us
  about quantity discounts and multi-user licenses.

1. GETTING HELP
---------------
  If you have any problems, please consult this file, the file
  CW_QA.TXT, 'Codewright User Guide' or 'Codewright API Reference'
  manuals first.  If you still have a question and need assistance,
  help is available from the following sources:

  a. CompuServe Section -- Visit us in section and library 9 of the
     WINAPA forum on CompuServe.  Tech support and other Codewright
     users can often give you quick help if you logon and leave a
     message.  There are also useful files available for download
     there.

  b. FAX - (503)641-6001

  c. BBS - (503)646-1374.  You are welcome to leave messages, report
     bugs, or make suggestions here.  File area 3 contains Codewright
     specific add-ons, patches and applications.
     
  d. BIX - Join WINDOWS.SUPP/PREMIA.CW, or send a note to dkinzer@bix.com.

  e. Write to us at the following address:

     Premia Corporation
     1075 NW Murray Boulevard, Suite 268
     Portland, Oregon 97229

  f. If you urgently require information to continue using
     Codewright, or if you have an urgent bug report, give us
     a call at (503)641-6000.


2. INSTALLATION
---------------

  You must use the INSTALL.EXE program on 'Disk 1: Install and 
  Executables' to install Codewright.  Most of the files on the
  distribution disks are compressed and need to be properly
  decompressed.

  To start the installation, execute the INSTALL.EXE program on
  Disk 1 from within Windows.  You will be prompted via a dialog
  box for additional disks.  If you don't intend to modify Codewright
  you may choose not to install the DLL C source code.  This will
  save both time and disk space.  The source code may be installed
  later if you need it.


3. LATE CHANGES
----------------

  This section describes changes that were made to the program after
  the manuals went to the printer.  The descriptions in the manuals
  differ substantially from the program in these areas.  We regret
  the confusion this may cause you, but feel that the improvements
  that these changes afford will make up for it.  You will find
  corrected descriptions for these topics in the on-line help.

  A) Comment Boxes -- The dialog described on pages 224 and 225 of
  the Codewright User's Guide is not on the Edit/Block Processing
  submenu as indicated in the manual.  It is instead the Comment
  Settings item on the Options menu.  The Comment Box item on the
  Block Processing submenu performs the Comment With Border action
  described on page 224.

  B) Help Indexes and HelpScan -- The Help Editor dialog described on
  pages 199 - 201 of the Codewright User's Guide has been
  changed.  Windows Help files can now be scanned directly for topics
  without going through the intermediate Help Information File stage.
  This simplifies adding topics to your Help Index and virtually
  eliminates the need for the HelpScan utility described on page 201.

  C) Version Control Dialogs -- The Check-in, Check-out, and Version
  Control Setup dialogs described on pages 135 - 142 of the
  Codewright User's Guide have been changed.  A response file macro
  (%Q) has been added, along with a place to enter the contents of
  this response file.  This lets you enter a description of changes
  in a revision from within the dialog, or to cause the user to be
  prompted for such a description.  You may also use it to supply
  additional parameters to a command.

  D) History Editor -- This dialog, described on page 226 of the
  Codewright User's Guide is now located on the Utility Menu.

  E) Compiling with VDOS installed -- VDOS comes initially disabled
  in the cwright.ini file, however it is easily installed by 
  removing the comment character (;) and restarting Codewright.
  Compilations within VDOS are triggered by invoking the compile/make/rebuild
  with both the 'Capture Output' and 'No shell command' flags OFF.
  The default compiler setting for capture output is normally ON.
  Also, there is an error file specified for the default project.  If
  an error file is specified, it is always used as the source of error 
  messages for the 'Build Window'.  If you are using VDOS to capture 
  the output, be sure to clear the 'Error Filename' field so that 
  Codewright will not use it for the error listing.

  F) 3D Controls -- To enable greyed 3D controls within Codewright,
  removed the comment character (;) in from of ';LibPreload=cwctl3d.dll'
  in the cwright.ini file.  If you have ctl3dv2.dll installed in the
  Window System directory, all dialog boxes within Codewright will have the
  desired 3D look.  If you don't have ctl3dv2.dll, you may retrieve it from
  the Codewright Install Disk 3.


4. REBUILDING DLLs:
---------------------
  
  Each Codewright subdirectory contains the source code for the
  like-named DLL.  For example: .\SAMPLE contains the source code for
  SAMPLE.DLL.  Each subdirectory also contains simple make files for
  compiling and linking all of the code in the directory.

  We have built all DLL's with both Microsoft 'C' and Borland 'C'.
  Either compiler will work, provided you use the right make file.
  For example, if you have added something to the source code for
  SAMPLE.DLL, you use the makefile SAMPLE for Microsoft and
  SAMPLE.MAK for Borland.


5. UNDOCUMENTED API FUNCTIONS
-----------------------------

There are now nearly 800 functions in Codewright's DOCUMENTED API.
In order to avoid hiding useful functions among functions that are
rarely useful, we have decided to document some of them only in
Specialized Application Notes.  The Specialized Application Notes
currently available are listed below:

     Differencing Primitives
	 Menu Configuration Functions

There are also functions that there was not time to document.  These
will be added to the help file in the near future.  

BufSetTempDir
void WINAPI BufSetTempDir( LPSTR );
Set the directory used for temporary files.

DosBoxPromptChar
void DosBoxPromptChar( LPSTR lpch )
Since VDOS assumes that '>' is the separator between the DOS prompt
and the input command, you must change the DosBoxPromptChar() to
reflect any changes to the prompt.

DosBoxPrompt
void DosBoxPrompt( LPSTR prompt )
Allows setting of the DOS box prompt.  The default is $P$G.

DosBoxExec
int DosBoxExec( LPSTR szArg )
The string of characters specified by szArg are entered into the
VDOS keyboard buffer and processed when time allows.  Control will
return immediately.

ExecOutputCommand
int ExecOutputCommand( LPSTR cmnd )
Given a DOS command line, it is executed in the DOS output window.
Control will not return until the command is finished or the user
changes the active window manually (Alt-Tab, mouse, ...).

VCSUseVDOS
BOOL VCSUseVDOS( BOOL )
If the parameter passed it TRUE, then all VCS operation will
be performed through the DOS output window.  Be aware that not
all VCS applications use STDIO for input and output.




6. HISTORY
----------
    Version 3.1    - Released 09/09/94

