Perforce for Ruby
			    -----------------

Requirements
------------

You *need* the Perforce API (p4api.tar) from the Perforce FTP site. The URL
is:
	ftp://ftp.perforce.com/pub/perforce

or 
	http://www.perforce.com/downloads/perforce


Building
--------

UNIX Builds:

    Unpack the Perforce API into a new directory - but *NOT* in the same 
    directory as this extension (mkmf won't like it). 

    Then run:

	ruby p4conf.rb 	--apidir <path to api> --apiver <api version>
	make
	make install

    For the last step, you'll probably need to be root.

Windows Builds:

    You will need Visual Studio to build P4/Ruby as mkmf generates nmake
    compatible makefiles.

    Unpack the Perforce API into a new directory - but *NOT* in the same 
    directory as this extension (mkmf won't like it). 

    Then run:

	ruby p4conf.rb 	--apidir <path to api> --apiver <api version>
	nmake
	nmake install
	

Cygwin Builds:

    For Cygwin builds you currently (08/2003) have to have the gcc-2 
    package installed and you must build P4Ruby with that compiler rather
    than gcc-3.  To do this, use the undocumented --gccver=2 flag. This 
    flag is undocumented because I hope it will eventually go away and 
    currently Cygwin is the only platform on which it has any effect. e.g.

	ruby p4conf.rb 	--apidir <path to api> --apiver <api version> --gccver=2
	make
	make install

    Do NOT attempt to build the P4Ruby for use with Cygwin's Ruby build 
    without using the Cygwin version of the Perforce API! Many people think
    they can use the Windows build of the API, but it won't work, so don't
    waste your time.