Skip to content

Commit

Permalink
Update readme + composer requirements; move license file and drop bui…
Browse files Browse the repository at this point in the history
…ld.xml
  • Loading branch information
usox committed Sep 1, 2015
1 parent ec1e3f4 commit 6c4dfb2
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 330 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ build
/doc/temp/
/docs/
/tools/phpunit
/tools/jsonlint
/tools/phpdoc
/tools/phpdoc.php
/tools/validate-json
File renamed without changes.
10 changes: 3 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
.PHONY: all

all::
phing
all::test docs doc

test::
phing test

tar::
phing tar
tools/phpunit

docs::
phing doc
tools/phpdoc -d classes -t docs -p

doc::
$(MAKE) $(MFLAGS) -C doc
Expand Down
73 changes: 32 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,55 @@

# PHPTAL - Template Attribute Language for PHP

Master: [![Build Status](https://secure.travis-ci.org/pornel/PHPTAL.png?branch=master)](http://travis-ci.org/pornel/PHPTAL)
[![Monthly Downloads](https://poser.pugx.org/phptal/phptal/d/monthly)](https://packagist.org/packages/phptal/phptal)
[![License](https://poser.pugx.org/phptal/phptal/license)](LICENSE)
[![Build Status](https://secure.travis-ci.org/pornel/PHPTAL.png?branch=master)](http://travis-ci.org/pornel/PHPTAL)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/phptal/PHPTAL/badges/quality-score.png)](https://scrutinizer-ci.com/g/phptal/PHPTAL/)

Usage requirements
==================
Requirements
============

To use PHPTAL in your projects, you will only require PHP 5.1.2 or later.

If you want to use the builtin internationalisation system (I18N) the gettext extension must be compiled into PHP (`--with-gettext`).
If you want to use the builtin internationalisation system (I18N), the php-gettext extension must be installed or compiled into PHP (`--with-gettext`).

Composer install (recommended)
==============================

You can install this package by using [Composer](http://getcomposer.org).
Link to Packagist: https://packagist.org/packages/phptal/phptal

Non-PEAR install
================
```
{
"require": {
"phptal/phptal": "~1.3"
}
}
```

To run you only need PHPTAL.php and files in PHPTAL directory. Other files are for unit tests and PEAR installer.
Manual install
==============

Get the latest PHPTAL package from http://phptal.org.
Get the latest PHPTAL tarball from https://github.com/phptal/PHPTAL/releases

tar zxvf PHPTAL-X.X.X.tar.gz
mv PHPTAL-X.X.X/PHPTAL* /path/to/your/php/include/path/

Changelog
=========

PEAR Install
============

Get the latest PHPTAL package from http://phptal.org.

Then run:

pear install PHPTAL-X.X.X.tar.gz


[Please see the projects releases page](https://github.com/phptal/PHPTAL/releases)

Getting the latest development version
======================================

You can checkout the latest development version using:

svn co https://svn.motion-twin.com/phptal/trunk phptal



PHPTAL development requirements
===============================

If you want to hack PHPTAL (don't forget to send me patches), you will require:

- The PHPTAL development package
- PEAR (to easily install other tools)
http://pear.php.net

- Phing to run maintainance tasks
You can find the latest development version on github:

pear channel-discover pear.phing.info
pear install phing/phing
https://github.com/phptal/PHPTAL

- PHPUnit 3.4 to run tests
Addition development requirements (optional)
============================================

pear channel-discover pear.phpunit.de
pear channel-discover pear.symfony-project.com
pear channel-discover components.ez.no
pear install phpunit/PHPUnit
If you would like to generate the offical html/text handbook by calling
`make doc`, you will need to install the `xmlto` package. Please use
your operating systems package manager to install it.
218 changes: 0 additions & 218 deletions build.xml

This file was deleted.

4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@
"php": ">=5.1.2"
},
"require-dev": {
"phpunit/phpunit": "~3.7.0"
"php": ">=5.3.3",
"phpunit/phpunit": "~4.8",
"phpdocumentor/phpdocumentor": "~2.8"
},
"autoload": {
"psr-0": {
Expand Down
Loading

0 comments on commit 6c4dfb2

Please sign in to comment.