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

resurtm committed
12 13
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)

14

Qiang Xue committed
15 16
DIRECTORY STRUCTURE
-------------------
17

Qiang Xue committed
18
      apps/                ready-to-use Web apps built on Yii 2
19
          basic/           a simple app supporting user login and contact page
Qiang Xue committed
20 21
      build/               internally used build tools
      docs/                documentation
22
      yii/                 framework source files
Qiang Xue committed
23
      tests/               tests of the core framework code
24 25 26 27 28


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

Qiang Xue committed
29
The minimum requirement by Yii is that your Web server supports PHP 5.3.?.
30 31


32 33 34 35 36 37 38 39 40
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.

We are writing more documentation to get you started and learn more in depth.


Qiang Xue committed
41 42
HOW TO PARTICIPATE
------------------
43

44 45 46
**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:
47

Qiang Xue committed
48 49 50
* [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
51
    - 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
52
    - Please submit a merge request after you finish development.
53