Skip to content

Commit

Permalink
Converting installation documentation to markdown. Updating reference…
Browse files Browse the repository at this point in the history
…s between doc files.
  • Loading branch information
Ocramius committed Mar 8, 2012
1 parent cdb99d1 commit edddac3
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 75 deletions.
67 changes: 67 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 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`. To use
components in the extras library, add the `extras/library` directory to
your PHP `include_path` as well.

If you would like to use Zend_Tool, simply add `bin/zf.bat` (for Windows)
or `bin/zf.sh` (for anything else) to your system executable path.

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

Zend Framework 2 requires PHP 5.3.1 or later.

## DEVELOPMENT VERSIONS

If you would like to preview enhancements or bug fixes that have not yet
been released, you can obtain the current development version of Zend
Framework using one of the following methods:

- Using a Git client. Zend Framework is open source software, and the
Git repository used for its development is publicly available.
Consider using Git to get Zend Framework if you already use Git for
your application development, want to contribute back to the
framework, or need to upgrade your framework version very often.

- Checking out a working copy is necessary if you would like to directly
contribute to Zend Framework; a working copy can be updated any time
using git pull.

To clone the git repository, use the following URL:

git://git.zendframework.com/zf.git

For more information about Git, please see the official website:

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:

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

Instructions on how to change PHP configuration directives can be found
here:

http://www.php.net/manual/en/configuration.changes.php

## GETTING STARTED

A great place to get up-to-speed quickly is the Zend Framework
QuickStart:

http://framework.zend.com/manual/en/learning.quickstart.html

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.
72 changes: 0 additions & 72 deletions INSTALL.txt

This file was deleted.

2 changes: 1 addition & 1 deletion README-DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ read/subscribe to the following resources:
- Coding Standards:
http://framework.zend.com/manual/en/coding-standard.html
- ZF Git Guide:
README-GIT.txt
README-GIT.md
- Contributor's Guide:
http://framework.zend.com/wiki/display/ZFDEV/Contributing+to+Zend+Framework
- ZF Contributor's mailing list:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,12 @@ latest PHP version whenever possible.

### INSTALLATION

Please see INSTALL.txt.
Please see INSTALL.md.

### CONTRIBUTING

If you wish to contribute to Zend Framework 2.0, please read both the
README-DEV.txt and README-GIT.txt file.
README-DEV.md and README-GIT.md file.

### QUESTIONS AND FEEDBACK

Expand Down

0 comments on commit edddac3

Please sign in to comment.