############# # Basic Usage # ############# Use Phing to manage this project. To list all of the available commands, do: phing -l To build a release, type: phing build -Dversion=1.0.0 Leaving -Dversion off will result in a "snapshot" release. To learn about more options, type phing longhelp ############ # THE BASICS # ############ To build XdebugUtils, run: phing build This will create a complete distribution of the project in /dist, with the build files in /bin/build. Documentation will be generated if the appropriate target is configured. A versioned release can be built with: phing build -Dversion=2.1.1alpha1 To see all available build targets, run this command: phing -l Check Configuration =================== To check how your project is configured, use the 'info' target: phing info This will print details about the project. Syntax Check ============ To check the syntax of all of your PHP source code, run this: phing lint It will generate a report on any files that fail to parse correctly. Generating Documentation ======================== To generate docs, do: phing doc Documentation will be stored in doc/. You can start with doc/index.html. Running Unit Tests ================== To run any configured tests, do: phing test The above will generate HTML test results which will be placed in test/reports/. If you wish to run the test and print the results directly the the command line (fast tests), you should run 'phing ftest' instead. phing ftest Code Coverage Reports ===================== To run coverage analysis, do: phing coverage This will create HTML pages describing code coverage. The coverage analysis will be available in test/coverage ################### # OPTIONAL FEATURES # ################### Phar Packages ============= This script can produce Phar packages on systems with PHP 5.3: phing pharBuild TextMate Integration ==================== If you are a TextMate user, you can install the Phing TextMate bundle (http://github.com/technosophos/phing-tmbundle) to get some special TextMate features. Special TextMate keybindings: CMD-U: Run any target in the build file CMD-SHIFT-I: Run the tmtest unit test target CMD-SHIFT-U: Run the tmtarget target, which you can configure to do whatever you want Pear Channel Support ==================== This script will generate PEAR-compatible packages, provided you configure your settings correctly. If you use Pirum (http://pirum-project.org) to manage your PEAR channel, you can use the Phing-Pirum package (http://github.com/technosophos/Phing-Pirum) to build or manage the channel from these scripts. You need to edit the Pirum configuration in build.xml, though. Pyrus Support ============= We are experimenting with supporting Pyrus, the next generation PEAR client. Pyrus can build packages much more effectively, and supports a wide range of useful commands. Currently, we are working on two targets: phing pyrusMake phing pyrusPackage ======== To print this message, do: phing longhelp This is a useful PHP project. Project name: ${project.name} By ${project.lead} (${project.lead.email}) Summary: ${project.summary} Description: ${project.description} Source code: ${srcdir} Complete packages: ${packagedir} Version string pattern: ${project.name}-dev${DSTAMP} Edit project.properties (or build.xml) to set the above. Executed tmtarget in build.xml. ${releasedir}