README.md 3.57 KB
Newer Older
Qiang Xue committed
1 2
Yii PHP Framework Version 2
===========================
3

Qiang Xue committed
4
Thank you for choosing Yii 2 - a modern PHP framework designed for professional Web development.
5

Qiang Xue committed
6 7
Yii 2 is a complete rewrite of its previous version Yii 1.1 which is one of the most popular PHP frameworks.
Yii 2 inherits the main spirit behind Yii for being simple, fast and highly extensible.
Qiang Xue committed
8
Yii 2 requires PHP 5.4 and embraces the best practices and protocols found in modern Web application development.
Qiang Xue committed
9 10


11 12
[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2/v/stable.png)](https://packagist.org/packages/yiisoft/yii2)
[![Total Downloads](https://poser.pugx.org/yiisoft/yii2/downloads.png)](https://packagist.org/packages/yiisoft/yii2)
13
[![Reference Status](https://www.versioneye.com/php/yiisoft:yii2/reference_badge.svg)](https://www.versioneye.com/php/yiisoft:yii2/references)
14
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
15 16
[![Dependency Status](https://www.versioneye.com/php/yiisoft:yii2/dev-master/badge.png)](https://www.versioneye.com/php/yiisoft:yii2/dev-master)
[![HHVM Status](http://hhvm.h4cc.de/badge/yiisoft/yii2-dev.png)](http://hhvm.h4cc.de/package/yiisoft/yii2-dev)
17
[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/coverage.png?s=31d80f1036099e9d6a3e4d7738f6b000b3c3d10e)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
18
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/quality-score.png?s=b1074a1ff6d0b214d54fa5ab7abbb90fc092471d)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
19
[![Code Climate](https://codeclimate.com/github/yiisoft/yii2.png)](https://codeclimate.com/github/yiisoft/yii2)
20

Qiang Xue committed
21 22
DIRECTORY STRUCTURE
-------------------
23

Qiang Xue committed
24 25 26 27 28 29 30 31 32 33
```
apps/                ready-to-use application templates
    advanced/        a template suitable for building sophisticated Web applications
    basic/           a template suitable for building simple Web applications
    benchmark/       an application demonstrating the performance of Yii
build/               internally used build tools
docs/                documentation
extensions/          extensions
framework/           core framework code
tests/               tests of the core framework code
Qiang Xue committed
34
```
35 36 37 38 39


REQUIREMENTS
------------

40
The minimum requirement by Yii is that your Web server supports PHP 5.4.
41 42


43 44 45
DOCUMENTATION
-------------

Qiang Xue committed
46 47
Yii 2.0 has a [Definitive Guide](http://www.yiiframework.com/doc-2.0/guide-index.html) and 
a [Class Reference](http://www.yiiframework.com/doc-2.0/index.html) which cover every detail of Yii.
Carsten Brandt committed
48

Qiang Xue committed
49 50
There is also a [PDF version](http://stuff.cebe.cc/yii2-guide.pdf) of the Definitive Guide
and a [Definitive Guide Mirror](http://stuff.cebe.cc/yii2docs/) which update every 15 minutes.
Carsten Brandt committed
51

Qiang Xue committed
52
For 1.1 users, you may refer to [Upgrading from Yii 1.1](docs/guide/intro-upgrade-from-v1.md)
53 54 55
to have a general idea of what has changed in 2.0.


Qiang Xue committed
56 57
HOW TO PARTICIPATE
------------------
58

59 60 61
**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:
62

Qiang Xue committed
63 64 65
* [Report issues](https://github.com/yiisoft/yii2/issues)
* [Give us feedback or start a design discussion](http://www.yiiframework.com/forum/index.php/forum/42-design-discussions-for-yii-20/)
* Fix issues, develop features, write/polish documentation
Qiang Xue committed
66
    - Before you start, please adopt an existing issue (labelled with "ready for adoption") or start a new one to avoid duplicated efforts.
Qiang Xue committed
67
    - Please submit a merge request after you finish development.
68

69 70
In order to make it easier we've prepared [special `yii2-dev` Composer package](https://github.com/yiisoft/yii2/blob/master/docs/internals/getting-started.md).