Skip to content

Commit

Permalink
update root docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefano Torresi committed Jan 11, 2015
1 parent e38b533 commit 2c79be6
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 16 deletions.
38 changes: 25 additions & 13 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# INSTALLATION

Zend Framework requires no special installation steps. Simply download
the framework, extract it to the folder you would like to keep it in,
and add the library directory to your PHP `include_path`.
Although Zend Framework requires no special installation steps,
we highly recommend using [Composer][composer].
However, you can simply download the framework, extract it to the folder you
would like to keep it in, and add the `library` directory to your PHP
`include_path`.


## SYSTEM REQUIREMENTS
-------------------

Zend Framework 2 requires PHP 5.3.23 or later.
Please refer to the [installation instructions][installation] in the [manual]
for more details.

## DEVELOPMENT VERSIONS

Expand Down Expand Up @@ -37,11 +36,19 @@ http://www.git-scm.org
## CONFIGURING THE INCLUDE PATH

Once you have a copy of Zend Framework available, your application will
need to access the framework classes. Though there are several ways to
achieve this, your PHP `include_path` needs to contain the path to the
Zend Framework classes under the `/library` directory in this
distribution. You can find out more about the PHP `include_path`
configuration directive here:
need to access the framework classes.

If you're using [Composer][composer], you just need to add `require
"vendor/autoload.php"` at the very beginning of your application main entry
point (i.e. `index.php`).
Please not that this has already been done for you if you're using the
default [ZendSkeletonApplication][ZendSkeletonApplication].

However, if you're not using [Composer][composer], there are several other
ways to achieve this: one is to set your PHP `include_path` so that it
contains the path to the Zend Framework classes under the `/library`
directory in this distribution. You can find out more about the PHP
`include_path` configuration directive here:

http://www.php.net/manual/en/ini.core.php#ini.include-path

Expand All @@ -61,3 +68,8 @@ The QuickStart covers some of the most commonly used components of ZF.
Since Zend Framework is designed with a use-at-will architecture and
components are loosely coupled, you can select and use only those
components that are needed for your project.

[manual]: http://framework.zend.com/manual
[installation]: http://framework.zend.com/manual/current/en/ref/installation.html
[composer]: http://getcomposer.org
[ZendSkeletonApplication]: https://github.com/zendframework/ZendSkeletonApplication
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ DD MMM YYY

### UPDATES IN 2.4.0

- [#7095](https://github.com/zendframework/zf2/issues/7095) drops support for
PHP 5.3
- [#6154](https://github.com/zendframework/zf2/pull/6154) updates
`Zend\InputFilter\BaseInputFilter::isValid()` to accept an optional `$context`
parameter; if used, this value will be passed to all composed inputs as
Expand All @@ -28,10 +30,13 @@ DD MMM YYY

Please see [CHANGELOG.md](CHANGELOG.md).

### SYSTEM REQUIREMENTS
## SYSTEM REQUIREMENTS
-------------------

Zend Framework 2 requires PHP 5.3.23 or later; we recommend using the
latest PHP version whenever possible.
Zend Framework 2 requires PHP 5.4 or later.
Please be wary that the minimum PHP version may be bumped in subsequent
framework releases; we hence encourage to use [Composer][composer] to ensure
that your application environment satisfies the requirements.

### INSTALLATION

Expand Down

0 comments on commit 2c79be6

Please sign in to comment.