QVCS/QVCS-Pro - Quma Version Control System $Version: 3.10.20 $
$Copyright  1997-2010 Quma Software, Inc. ALL RIGHTS RESERVED WORLDWIDE. $

RIGHTS TO USE AND DISCLAIMER:
================================================================
This version of QVCS/QVCS-Pro (the Product) may be distributed 
provided it is distributed in the same form that it was received. 
Any distribution MUST include this readme.txt file and all the 
files listed in the readme.txt.  Any use of the Product 
(commercial or non-commercial) is encouraged, though Quma 
Software, Inc. provides NO WARRANTY OF ANY KIND, EITHER EXPRESS 
OR IMPLIED, THAT THE PRODUCT IS USEFUL FOR ANYTHING. IN NO 
EVENT SHALL QUMA SOFTWARE, INC. BE LIABLE FOR ANY DAMAGES 
WHATSOEVER INCLUDING DIRECT, INDIRECT, INCIDENTAL, 
CONSEQUENTIAL, LOSS OF BUSINESS PROFITS OR SPECIAL DAMAGES, 
EVEN IF QUMA SOFTWARE, INC. HAS BEEN ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGES. 

If after 60 days of use, you want to continue to use the Product, 
you must pay a registration fee. See the license.txt file for 
details.
================================================================

This file briefly describes how to get started using 
QVCS/QVCS-Pro.

QVCS and QVCS-Pro are both distributed with this installation.
During the 60-day evaluation period, this distribution supplies 
the full functionality of QVCS-Pro.  When you purchase your 
license, you will receive a license file that these programs 
use to determine whether they will provide QVCS or QVCS-Pro 
features.

For this release, QVCS-Pro provides all the features of QVCS, 
and adds:

* Support for IDE integration, which allows QVCS to provide 
  version control services to IDEs that support Microsoft's 
  SCC API.
* Support for elementary drag and drop.
* Support for elementary triggers.
* Support for directory recursion from the command line (the 
  qrecurse command line tool).

See the product help file (qvcs3.hlp) for greater details about 
these features.

================================================================

The installer will put these files on your system:

readme.txt	what you're reading
upgrade.txt	describes 3.10 changes for earlier QVCS/QVCS-Pro 
		users.
license.txt	The QVCS and QVCS-Pro license terms.
purchase.txt	describes how to buy QVCS or QVCS-Pro.
tips.txt	A file that contains the "Tip of the Day" tips 
		that appear when you launch QWin3.exe.

qput.exe	command line tool: store (put) a revision in a 
		QVCS archive
qget.exe	command line tool: fetch (get) a revision
qlock.exe	command line tool: lock a revision
qlog.exe	command line tool: report QVCS archive and 
		revision info
qident.exe	command line tool: find QVCS keywords in any file
qmodhdr.exe	command line tool: modify QVCS archive header info
qmerge.exe	command line tool: merge separate edits of same 
		file
qdelrev.exe	command line tool: delete revisions from a QVCS 
		archive
qmodrev.exe	command line tool: modify QVCS archive info for 
		specific revision
qdiff.exe	command line tool: compare files and/or revisions
qedit.exe	command line tool: apply results of qdiff to 
		convert a file from one revision to another
qstamp.exe	command line tool: apply a version label to a 
		QVCS archive or set of QVCS archives
qunlock.exe	command line tool: unlock a revision
qunstamp.exe	command line tool: remove a version label from a 
		QVCS archive or set of QVCS archives
qrecurse.exe	command line tool: command line tool that allows 
		you to recurse directories. This is useful for 
		getting an entire project tree, for example. 
		(QVCS-Pro only)

qwin3.exe	GUI QVCS application

qvcsscc.dll	QVCS dll used to provide IDE version control 
		integration for Microsoft SCC compliant IDEs.
qwin3.hlp	Windows help file for qwin3 and QVCS.
qwin3.cnt	Windows help contents file.

qvcsmsgf	message file used by all QVCS utilities.

SimpleTrigger.exe	Simple trigger program 
			(useful for QVCS-Pro only)
SimpleTrigger.zip	Source and project files for building
			SimpleTrigger.exe
TriggerDll.dll		Simple dll based trigger
			(useful for QVCS-Pro only)
TriggerDll.zip		Source and project files for building
			TriggerDll.dll


The Minimum you must do to use QVCS:
================================================================
1. Install QVCS/QVCS-Pro into a single directory. If you plan on 
   working in a team environment, install QVCS/QVCS-Pro into a 
   network directory accessible to anyone that you expect to use 
   it.  MAKE SURE THEY HAVE READ/WRITE RIGHTS TO THE DIRECTORY.
   (If you want to use QVCS-Pro with Visual Studio 2005, you 
   MUST install QVCS-Pro to a local directory.).

2. Launch qwin3.exe.  It will guide you through logging in for 
   the first time.

3. Consult the on-line help for additional guidance.



Additional setup steps to use the command line utilities:
================================================================
4. Add an entry to your path for the directory where you 
   installed QVCS/QVCS-Pro.

5. Reboot or logoff and logon so your changes to the environment 
   can take effect.


Additional steps if you want to integrate QVCS-Pro with an IDE:
================================================================
6. Start QWin3, and after defining at least one QVCS user, 
   define a project that identifies where you want QVCS to store 
   the archives associated with the files that you maintain 
   within the IDE.

7. In QWin3, on the Admin/IDE Integration menu select the kind of
   IDE behavior you need from QVCS.  Some IDE's require QVCS to be
   the 'default' version control tool (e.g. Microsoft's VC++); 
   others will work so long as QVCS is installed as a version 
   control supplier.


QVCS/QVCS-Pro Briefly:
================================================================
QVCS/QVCS-Pro is a version control system.  It allows you to 
capture snapshots of work in progress so you can safely move on 
to newer revisions of your work.  It matches most of the features 
of market leading products, and introduces several features that 
make it uniquely valuable.

QVCS/QVCS-Pro has been tested on Windows NT/4.0, Windows 2000, 
and Windows XP.  It may work on Windows 98 and/or Windows Me,
but we do not test on those platforms.

For the command line utilities, typing the name of any QVCS 
utility with no other command line arguments will display the 
help topic for that utility.


Standard QVCS/QVCS-Pro features include:
================================================================
* save a file revision
* retrieve a file revision
* lock a revision for update
* unlock a locked revision
* parallel development of the same source file (branching)
* compress QVCS archives to minimize storage
* embed revision comments in source at point of revision.
* enter a comment at checkout time so others can see why you 
  are working on a file.
* "floating" versions
* "automatic" branching
* integration with Microsoft SCC compliant tools and IDEs 
  (QVCS-Pro only)
* elementary trigger support (QVCS-Pro only)
* elementary drag and drop support (QVCS-Pro only)
* etc...


Features unique to QVCS/QVCS-Pro:
================================================================
* You can alter revision descriptions and have the altered 
  descriptions appear in your source code without having to 
  separately edit your source code.
* You can alter a module description and have the altered 
  description appear in your source code without having to 
  separately edit your source code.
* Unique $LogXX$ keyword allows you to show only the most recent 
  XX revision descriptions in your source.  For example, a 
  LogXX of Log5 will expand only the 5 newest revision 
  descriptions.
* Turn off keyword expansion when fetching revisions to leave 
  keywords in their unexpanded state for ease in editing.
* The QVCS message file allows you to customize QVCS to suit 
  your tastes.

Please read license.txt for terms and conditions of use.

Please read purchase.txt for information on purchasing your 
QVCS-Pro or QVCS license.

Suggestions for improvements are always welcome.  

Bug reports too, are welcome from registered and unregistered 
users alike.


QVCS Keywords:
================================================================
If you enable keyword expansion, QVCS will expand keywords to 
provide automated documentation for your source files.  QVCS 
supports the following keywords (for expanded examples of the 
Version and Copyright keywords, see the top of this file):

Author		expands to the author of the current revision.
Comment		allows you to embed revision comments within 
		your workfile and have those comments 
		automatically entered into the description 
		of that revision when stored.
Copyright	expands to a copyright message of your own.
Date		expands to the edit date of the file used to 
		create the current revision
Endlog		marks the end of and expanded log. You should 
		NOT use this keyword!
Filename	expands to the full name of the workfile into 
		which the revision is being retrieved.
FilePath	expands to the project relative name of the 
		workfile into which the revision is being 
		retrieved.
Header		expands to the name of the workfile, the current
		revision, the file date, and the file owner.
HeaderPath	expands to the project relative name of the 
		workfile, the current revision, the file date, 
		and the file owner.
Log		expands to list ALL revision descriptions.
LogX		expands to list the X most recent revision 
		descriptions.
Logfile		expands to the full pathname of the QVCS 
		archive.
Owner		expands to the person who created the QVCS 
		archive.
Project		expands to the name of the current QVCS project.
Revision	expands to the revision number of the current 
		revision.
VER		expands to the name of the source file (without 
		the file extension), plus the version string 
		associated with the current revision.
Version		expands the the version name associated with 
		the current revision.  (Version names are 
		applied by qstamp or using the 'label' operation 
		in QWin3).


Limitations:
================================================================
* QVCS will only let you create branches to a depth of 20.
* QVCS does most of its work in memory.  If you work with really 
  large files, you'll need lots of memory in order for QVCS 
  utilities to succeed.
* The QVCS GUI application (QWin3.exe) and IDE integration will 
  cease to work after 60 days unless you pay the registration 
  fee.  The command line utilities (except for qrecurse) will 
  continue to work.


Bugs:
================================================================
To report bugs, please send e-mail to support@qumasoft.com 
describing the problem with as much detail as possible. When
sending e-mail, please include 'QVCS' in the e-mail subject line
so that we can distinguish your e-mail from the thousands of
SPAM messages that we get each day.


Updates:
================================================================
The latest version of QVCS/QVCS-Pro is always available on our 
website.

Generally the latest information on the current release is posted 
to the Quma Software Web site (www.qumasoft.com) so you should 
check there for information that may be more recent than the 
information contained here.


Forums:
================================================================
Forum support is available at:

http://qumasoft.ipbhost.com


For Your Protection:
================================================================
This program is produced by a member of the Association of 
Shareware Professionals (ASP). ASP wants to make sure that the 
shareware principle works for you. If you are unable to resolve 
a shareware-related problem with an ASP member by contacting 
the member directly, ASP may be able to help. The ASP Ombudsman 
can help you resolve a dispute or technical problem with an ASP 
member, but does not provide technical support for members' 
products. Please contact the ASP Ombudsman online at 
http://www.asp-shareware.com/omb.


Please communicate suggestions and bug reports to:
================================================================
support@qumasoft.com 

or

http://qumasoft.ipbhost.com

or

Phone:	(443) 415-4890

or

FAX: 	(202) 478-0246

or

Quma Software, Inc.
20 Warren Manor Court
Cockeysville, MD  21030
