README.md 2.45 KB
Newer Older
Qiang Xue committed
1 2
Yii 2.0 Public Preview
======================
3

Qiang Xue committed
4
Thank you for choosing Yii - a high-performance component-based PHP framework.
5

Qiang Xue committed
6 7 8
If you are looking for a production-ready PHP framework, please use
[Yii v1.1](https://github.com/yiisoft/yii).

Qiang Xue committed
9 10
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
11

12 13 14 15
[![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)
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2) 
[![Dependency Status](https://www.versioneye.com/php/yiisoft:yii2/dev-master/badge.png)](https://www.versioneye.com/php/yiisoft:yii2/dev-master)
resurtm committed
16

17

Qiang Xue committed
18 19
DIRECTORY STRUCTURE
-------------------
20

Qiang Xue committed
21
      apps/                ready-to-use Web apps built on Yii 2
22
          advanced/        advanced app template with complex features
23
          basic/           a simple app supporting user login and contact page
24
          benchmark/       app demonstrating the minimal overhead introduced by the framework
Qiang Xue committed
25 26
      build/               internally used build tools
      docs/                documentation
27 28 29
      extensions/          extensions 
      framework/           framework files
          yii/             framework source files
Qiang Xue committed
30
      tests/               tests of the core framework code
31 32 33 34 35


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

Qiang Xue committed
36
The minimum requirement by Yii is that your Web server supports PHP 5.3.?.
37 38


39 40 41 42 43 44
DOCUMENTATION
-------------

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.

45
[Definitive Guide draft](docs/guide/index.md) is available. It's not complete yet but main parts are already OK.
46 47


Qiang Xue committed
48 49
HOW TO PARTICIPATE
------------------
50

51 52 53
**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:
54

Qiang Xue committed
55 56 57
* [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
58
    - 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
59
    - Please submit a merge request after you finish development.
60