README.md 3.65 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 8 9 10 11 12 13 14 15 16 17 18
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.
Yii 2 requires PHP 5.4 and embraces best practices and protocols found in modern Web application development.


**Yii 2 is not ready for production use yet.** We may make significant changes without prior notices.
We expect to make the first stable release of Yii 2 in early 2014.

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)
23
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
24
[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/coverage.png?s=31d80f1036099e9d6a3e4d7738f6b000b3c3d10e)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
25
[![Dependency Status](https://www.versioneye.com/php/yiisoft:yii2/dev-master/badge.png)](https://www.versioneye.com/php/yiisoft:yii2/dev-master)
26
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/yiisoft/yii2/badges/quality-score.png?s=b1074a1ff6d0b214d54fa5ab7abbb90fc092471d)](https://scrutinizer-ci.com/g/yiisoft/yii2/)
27

Qiang Xue committed
28 29
DIRECTORY STRUCTURE
-------------------
30

Qiang Xue committed
31 32 33 34
      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
Qiang Xue committed
35 36
      build/               internally used build tools
      docs/                documentation
37
      extensions/          extensions
Qiang Xue committed
38
      framework/           core framework code
Qiang Xue committed
39
      tests/               tests of the core framework code
40 41 42 43 44


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

45
The minimum requirement by Yii is that your Web server supports PHP 5.4.
46 47


48 49 50
DOCUMENTATION
-------------

Qiang Xue committed
51 52
A draft of the [Definitive Guide](docs/guide/index.md) is available.

53
API docs and a rendering of the definitive guide are currently
Carsten Brandt committed
54
available at http://stuff.cebe.cc/yii2docs/ (updated four times per hour).
55
We will make guide and API docs available on yiiframework.com with the beta release.
Carsten Brandt committed
56

57 58 59 60
For 1.1 users, you may refer to [Upgrading from Yii 1.1](docs/guide/upgrade-from-v1.md)
to have a general idea of what has changed in 2.0.


Qiang Xue committed
61 62
HOW TO PARTICIPATE
------------------
63

64 65 66
**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:
67

Qiang Xue committed
68 69 70
* [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
71
    - 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
72
    - Please submit a merge request after you finish development.
73

74 75
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).