README.md 4.33 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


**Yii 2 is not ready for production use yet.** We may make significant changes without prior notices.
Qiang Xue committed
12
We expect to make the first stable release of Yii 2 in the middle of 2014.
Qiang Xue committed
13 14 15 16 17 18

If you mainly want to learn Yii with no real project development requirement, we highly recommend
you start with Yii 2 as it will be our main focus for the next few years.

If you have a real project with tight schedule, you should stick to [Yii 1.1](https://github.com/yiisoft/yii)
which is the latest stable release of Yii.
Qiang Xue committed
19

20

21 22
[![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)
Carsten Brandt committed
23
[![Dependency Status](https://www.versioneye.com/php/yiisoft:yii2/dev-master/badge.png)](https://www.versioneye.com/php/yiisoft:yii2/dev-master)
24
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
Carsten Brandt committed
25
[![HHVM Status](http://hhvm.h4cc.de/badge/yiisoft/yii2-dev.png)](http://hhvm.h4cc.de/package/yiisoft/yii2-dev)  
26
[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/coverage.png?s=31d80f1036099e9d6a3e4d7738f6b000b3c3d10e)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
27
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/quality-score.png?s=b1074a1ff6d0b214d54fa5ab7abbb90fc092471d)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
28
[![Code Climate](https://codeclimate.com/github/yiisoft/yii2.png)](https://codeclimate.com/github/yiisoft/yii2)
29
[![Reference Status](https://www.versioneye.com/php/yiisoft:yii2/reference_badge.svg)](https://www.versioneye.com/php/yiisoft:yii2/references)
Carsten Brandt committed
30 31
[![Issue Stats Issues](http://issuestats.com/github/yiisoft/yii2/badge/issue)](http://issuestats.com/github/yiisoft/yii2)
[![Issue Stats Pull request](http://issuestats.com/github/yiisoft/yii2/badge/pr)](http://issuestats.com/github/yiisoft/yii2)
32

Qiang Xue committed
33 34
DIRECTORY STRUCTURE
-------------------
35

Qiang Xue committed
36 37 38 39 40 41 42 43 44 45
```
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
46
```
47 48 49 50 51


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

52
The minimum requirement by Yii is that your Web server supports PHP 5.4.
53 54


55 56 57
DOCUMENTATION
-------------

58
A draft of the [Definitive Guide](docs/guide/README.md) is available.
Qiang Xue committed
59

60
API docs and a rendering of the definitive guide are currently
Carsten Brandt committed
61 62
available under the following urls:

Qiang Xue committed
63 64
- http://www.yiiframework.com/doc-2.0/ API and Definitive Guide (updated daily)
- http://stuff.cebe.cc/yii2docs/ API and Definitive Guide (updated every 15 minutes)
Carsten Brandt committed
65
- http://stuff.cebe.cc/yii2-guide.pdf The PDF version of the Guide
Carsten Brandt committed
66

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


Qiang Xue committed
71 72
HOW TO PARTICIPATE
------------------
73

74 75 76
**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:
77

Qiang Xue committed
78 79 80
* [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
81
    - 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
82
    - Please submit a merge request after you finish development.
83

84 85
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).