disterics / p4ruby Goto Github PK

= P4Ruby -- Ruby interface to the Perforce API

This is only an installer for the P4Ruby package by Perforce Software.

== Install

  % gem install p4ruby

Or if you are installing from the regular (non-gem) package,

  % ruby install.rb

This installer downloads P4Ruby and the Perforce API, compiles P4Ruby,
and installs it.  On Windows the Perforce P4Ruby Windows installer is
downloaded and executed instead.  Some options are available,

  % ruby install.rb --help

  Usage: ruby install.rb [options]
    --version NN.N       Version to download, e.g. 10.2. Default finds latest.
    --list-versions      List available versions.
    --platform PLATFORM  Perforce-named platform to download. Default guesses.
    --list-platforms     List available platforms for the given version.
    --gem                Gem configuration (for the gem installer).
    --uninstall          Uninstall.
    --local              Use the files in work/distfiles (manual download).

== Links

* P4Ruby documentation: http://www.perforce.com/perforce/doc.current/manuals/p4script/p4script.pdf
* Perforce documentation: http://perforce.com/perforce/technical.html
* Manual Download (this installer only): http://github.com/quix/p4ruby/archives/master
* Repository (this installer only): http://github.com/quix/p4ruby
* Simplified wrapper for P4Ruby: http://perforce.rubyforge.org

== Credits

=== P4Ruby
 
 Copyright (c) 1997-2007, Perforce Software, Inc.  All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
 1. Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
 
 2. Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE
 SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
=== Installer and Gem
 
 This ruby package (install.rb and associated files) was written by
 James M. Lawrence.

 Copyright (c) 2009 James M. Lawrence
 Copyright (c) 2008 ImaginEngine, Inc.

 Distributed under the MIT license.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
 without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.