[GENERIC] Resources:
[zend.git] / INSTALL.txt
blob1b397394ddcd9b7923a64534268077898671ce10
1 INSTALLATION
2 ------------
4 Zend Framework requires no special installation steps. Simply download the framework,
5 extract it to the folder you would like to keep it in, and add the library directory
6 to your PHP include_path. To use components in the extras library, add the extras/library
7 directory to your PHP include_path, as well.
8 If you would like to use Zend_Tool, simply add bin/zf.bat (for Windows) or
9 bin/zf.sh (for anything else) to your system executable path.
11 SYSTEM REQUIREMENTS
12 -------------------
14 Zend Framework requires PHP 5.2.4 or later. Please see the system requirements
15 appendix for more detailed information:
17 http://framework.zend.com/manual/en/requirements.html
19 DEVELOPMENT VERSIONS
20 --------------------
22 If you would like to preview enhancements or bug fixes that have not yet been
23 released, you can obtain the current development version of Zend Framework using one
24 of the following methods:
26 * Download the latest nightly snapshot. For those who care to brave the cutting
27   (often bleeding) edge, the nightly snapshots represent the latest single-
28   download development version of Zend Framework development. Snapshots are bundled
29   with documentation in English only or in all available languages. If you anticipate
30   updating to the latest development version of Zend Framework often, consider using
31   Subversion as described below.
33   http://framework.zend.com/download/snapshot
35 * Using a Subversion (SVN) client. Zend Framework is open source software, and
36   the Subversion repository used for its development is publicly available. Consider
37   using SVN to get Zend Framework if you already use SVN for your application
38   development, want to contribute back to the framework, or need to upgrade your
39   framework version very often.
41   Exporting is useful if you want to get a particular framework revision without the
42   .svn  directories as created in a working copy.
44   Checking out a working copy is necessary if you would like to directly contribute
45   to Zend Framework; a working copy can be updated any time with svn update.
47   An externals definition is highly convenient for developers already using SVN to
48   manage their application working copies.
50   The URL for the trunk of the Zend Framework SVN repository is:
52   http://framework.zend.com/svn/framework/trunk
54   For more information about Subversion, please see the official website:
56   http://subversion.tigris.org
58 CONFIGURING THE INCLUDE PATH
59 ----------------------------
61 Once you have a copy of Zend Framework available, your application will need to
62 access the framework classes. Though there are several ways to achieve this, your
63 PHP include_path needs to contain the path to the Zend Framework classes under the
64 /library directory in this distribution. You can find out more about the PHP
65 include_path configuration directive here:
67 http://www.php.net/manual/en/ini.core.php#ini.include-path
69 Instructions on how to change PHP configuration directives can be found here:
71 http://www.php.net/manual/en/configuration.changes.php
73 GETTING STARTED
74 ---------------
76 A great place to get up-to-speed quickly is the Zend Framework QuickStart:
78 http://framework.zend.com/docs/quickstart
80 The QuickStart covers some of the most commonly used components of ZF. Since
81 Zend Framework is designed with a use-at-will architecture and components are
82 loosely coupled, you can select and use only those components that are needed for
83 your project.