Permalink
Browse files

Documentation commits in preparation for release.

  • Loading branch information...
1 parent 2de739a commit 737176c90712364a38ce40853f8cb5ac462e6fa8 @hozn hozn committed May 11, 2008
Showing with 160 additions and 1,326 deletions.
  1. +0 −125 INSTALL.UNIX
  2. +0 −116 INSTALL.WIN32
  3. +159 −1,036 LICENSE
  4. +1 −1 README
  5. +0 −48 TODO
View
@@ -1,125 +0,0 @@
- _________________________
- P H I N G
-
-
- Welcome to Phing!
- -----------------
-
- In this file you find a quick installation guide for PHING. For a more
- details regarding the setup procedure see the usersguide pdf or html
- in docs/.
-
-
- Prerequisites
- -------------
-
- At this point we assume you have a running Linux or other UNIX dialect with
- a properly installed release of PHP 5.0.2+. You need the CLI version of PHP,
- since there is no WEB-Application for Phing provided, and the ISAPI module
- will not work on command line. The PHP binary must have compiled-in XML
- support and optionally XSLT support if you want to use XSLT
- transformation
-
- We also assume you have shell-access to your system and your are logged in
- with the bash2 shell. If you're using tcsh, csh or other shells please refer
- to your shells' manpage for the syntax on how to set environment variables.
-
- PEAR Installation
- -----------------
-
- NOTE: As of Phing 2.0.0b1, Phing is available as a PEAR package. This
- makes installing Phing a million times easier than it already was (and
- most people say that it wasn't too hard in the first place). Visit
- http://phing.info to either download the latest Phing PEAR-installable
- package or to learn how to install directly over the network.
-
- If you are reading this document, then you are probably wanting to do
- the custom install, though, so read on ...
-
- Custom Installation
- -------------------
-
- +---------------------------------------------------------------------+
- | Note: for the sake of simple instructions, we will assume you are |
- | installing PHING to /opt/phing -- of course your installation path |
- | will probably be different. |
- +---------------------------------------------------------------------+
-
- First download a matching PHING distribution from http://phing.info and
- untar/gzip it to the desired install directory and optionally create a
- symlink for convinience:
-
- % cd /opt
- % tar xfz /path/to/phing-x.x.x.tar.gz
- % ln -s phing-x.x.x phing
-
- The shell script used to launch phing (bin/phing.sh) will attempt to guess
- most settings if you do not provide them explicitly. At this point you may
- want to try running Phing to see how you fare:
-
- % /opt/phing/bin/phing -version
-
- If that worked, then no further setup is necessary; however, you probably
- want to add a symlink /opt/phing/bin/phing to a location on your path:
-
- % ln -s /opt/phing/bin/phing /usr/local/bin/phing
-
-
- More Detailed Install Instruction
- ---------------------------------
-
- If Phing did not run out-of-the-box, then you will probably need to set some
- environment variables so that Phing knows where to find the PHP executable,
- necessary classes, etc.
-
- Now you have to set the PHP_COMMAND environment variable that points to
- the cli binary of php. For instance, Redhat Linux uses /usr/bin/php, and a
- compile from source installs by default in /usr/local/bin/php. We assume
- /usr/bin/php here. Execute the following command on the shell:
-
- % export PHP_COMMAND=/usr/bin/php
-
- Set the PHING_HOME to point to the installation directory of phing. If you
- are installing phing system wide, this is usually /opt/phing.
-
- % export PHING_HOME=/opt/phing
-
- Set the PHP_CLASSPATH variable to include $PHING_HOME/classes (optional)
-
- % export PHP_CLASSPATH="$PHING_HOME/classes"
-
- You can make additional classpath entries if there's a need for them. I.e.
- adding $BCHOME if you want to access binarycloud packages.
-
- Now you can add the phing executable to your PATH environment or add a
- symlink to it somewere in your path. We suggest adding a symlink in the
- bin/ dir and also add it to the path:
-
- % cd $PHING_HOME/bin
- % ln -s phing.sh phing
- % chmod +x phing
- % export PATH=$PATH:$PHING_HOME/bin
-
- You should now be able to execute Phing from everywhere in your system.
- Try it by changing back to your home and type:
-
- % phing -version
-
- Congratulations, you successfully installed Phing.
-
-
- Tips & Tricks
- -------------
-
- If you're using phing frequently consider adding the environment variables
- to you .bash_profile, .bashrc, etc.
-
- Another commonly used practice for advanced users is to create a build.sh
- file that sets all required variables and executes phing for your project.
- If you do so, you can savely override the bin/phing.sh file and use
- bin/phing.php directly without checking for environment. If you do so,
- there is basically only one varibale you have to set in your environment:
- PHING_HOME. See bin/phing.sh for details working with the phing.php script.
-
-
- --$Id$
View
@@ -1,116 +0,0 @@
- _________________________
- P H I N G
-
-
- Welcome to Phing!
- -----------------
-
- This is only a quick installation guide. For a more details procedure
- see the usersguide pdf in docs/pdf.
-
- Prerequisites
- -------------
-
- At this point we assume you have a running Windows NT/2000/XP system
- running and you properly installed PHP 5.0.2+. Windows 9x versions will
- probably work, but are not supported. Make sure that XSL is enabled (e.g.
- enable php_xsl.dll in your php.ini file) if you want to perform builds
- that require XSLT transformation (e.g. many Binarycloud buildfiles, the
- Phing "phing_guide" documentation buildfile).
-
- PEAR Installation
- -----------------
-
- NOTE: As of Phing 2.0.0b1, Phing is available as a PEAR package. This
- makes installing Phing a million times easier than it already was (and
- most people say that it wasn't too hard in the first place). Visit
- http://phing.info to either download the latest Phing PEAR-installable
- package or to learn how to install directly over the network.
-
- If you are reading this document, then you are probably wanting to do
- the custom install, though, so read on ...
-
- Custom Installation
- -------------------
-
- First download a matching PHING distribution from http://phing.info and
- unzip it to the desired install directory.
-
- +---------------------------------------------------------------------+
- | Note: On Windows 95 and Windows 98, the script used to launch |
- | Phing will have problems if PHING_HOME is a long filename. This is |
- | due to limitations in the OS's handling of the "for" batch-file |
- | statement. It is recommended, therefore, that Phing be installed in |
- | a short path, such as C:\opt\phing. |
- +---------------------------------------------------------------------+
-
- The batch script used to launch phing (bin\phing.bat) will attempt to
- guess most settings if you do not provide them explicitly. At this point
- you may want to try running Phing to see how you fare:
-
- C:\opt\phing\bin\phing -version
-
- If that worked, then no further setup is necessary; however, you probably
- want to add C:\opt\phing\bin to your PATH environment variable to make it
- easier to run Phing from any location.
-
- +---------------------------------------------------------------------+
- | Note: See http://www.cs.usask.ca/grads/wew036/latex/env.html for |
- | information on how to set environment variables. |
- +---------------------------------------------------------------------+
-
- More Detailed Install Instruction
- ---------------------------------
-
- If Phing did not run out-of-the-box, then you will probably need to set some
- environment variables so that Phing knows where to find the PHP executable,
- necessary classes, etc.
-
- * Setting %PHP_COMMAND%
-
- If your PHP executable is *not* on the PATH, then you should set the
- PHP_COMMAND environment variable to point to the CLI binary of PHP.
-
- For example, if you use the default install dir of PHP, you have to
- set:
-
- set PHP_COMMAND=C:\php\php.exe
-
- * Setting %PHING_HOME%
-
- You may also set the path to Phing's home directory. This is no longer
- necessary if you have not moved any files around (i.e. if the phing.bat
- file is in bin/ sub directory). If you encounter problems running Phing,
- you probably want to set this variable (just to be sure):
-
- set PHING_HOME=C:\opt\phing
-
- * Setting %PHP_CLASSPATH%
-
- You may also set a PHP_CLASSPATH variable to add any other locations to
- PHP's include_path (Of course, you may also simply add other locations
- directly to the include_path variable in php.ini):
-
- set PHP_CLASSPATH=%PHING_HOME%\classes
-
- You can make additional classpath entries if there's a need for them. I.e.
- adding %BCHOME% if you want to access binarycloud packages.
-
- * Setting %PATH%
-
- Now you can add the phing executable to your PATH environment:
-
- set PATH=%PATH%;%PHING_HOME%\bin
-
- You're Done!
- ------------
-
- You should now be able to execute Phing from everywhere in your system.
- Try it by changing back to your home and type:
-
- > phing -version
-
- Congratulations, you successfully installed Phing.
-
- --$Id$
-
Oops, something went wrong.

0 comments on commit 737176c

Please sign in to comment.