Skip to content

Commit 850808c

Browse files
Merge pull request #10053 from phalcon/2.0.0
Readme 2.0.0
2 parents c0fd010 + fdfc369 commit 850808c

File tree

1 file changed

+49
-32
lines changed

1 file changed

+49
-32
lines changed

README.md

+49-32
Original file line numberDiff line numberDiff line change
@@ -3,74 +3,91 @@ Phalcon Framework
33

44
Phalcon is an open source web framework delivered as a C extension for the PHP language providing high performance and lower resource consumption.
55

6-
This readme provides an introduction to contributing to `Phalcon 2.0`.
7-
86
Get Started
97
-----------
108

11-
Clone `Phalcon 2.0` repo:
9+
Phalcon is written in Zephir/C with platform independence in mind. As a result, Phalcon is available on Microsoft Windows, GNU/Linux, and Mac OS X. You can either download a binary package for the system of your choice or build it from sources.
1210

13-
```bash
14-
git clone -b 2.0.0 https://github.com/phalcon/cphalcon.git
15-
```
11+
### Windows
1612

17-
Clone [Zephir](https://github.com/phalcon/zephir) repo:
13+
To install Phalcon on Windows:
1814

19-
```bash
20-
git clone https://github.com/phalcon/zephir.git
21-
```
15+
1. Download [Phalcon for Windows](http://phalconphp.com/en/download/windows)
16+
2. Extract the DLL file and copy it to your PHP extensions directory
17+
3. Edit your php.ini file and add this line: `extension=php_phalcon.dll`
18+
4. Finally, restart your webserver
19+
20+
**Hint:** To ensure that your Phalcon installation was successful, debug with `<?php phpinfo(); ?>` and search for a section mentioning the Phalcon extension.
21+
22+
### Linux/Unix/Mac
23+
24+
On a Unix-based platform you can easily compile and install the extension from sources.
25+
26+
#### Requirements
27+
Prerequisite packages are:
28+
29+
* PHP 5.4.x/5.5.x/5.6.x development resources
30+
* GCC compiler (Linux/Solaris) or Xcode (Mac)
2231

23-
Clone [json-c](https://github.com/json-c/json-c.git) repo:
32+
Ubuntu:
2433

2534
```bash
26-
git clone https://github.com/json-c/json-c.git
35+
sudo apt-get install php5-dev libpcre3-dev gcc make
2736
```
2837

29-
Install required packages:
38+
Suse:
3039

3140
```bash
32-
sudo apt-get install php5-dev php5-mysql gcc make re2c libpcre3-dev
41+
sudo zypper install php5-devel gcc make
3342
```
3443

35-
Compile `json-c` and `Zephir`:
44+
CentOS/Fedora/RHEL
3645

3746
```bash
38-
cd zephir
39-
sudo ./install-json
40-
sudo ./install
41-
cd ..
47+
sudo yum install php-devel pcre-devel gcc make
4248
```
4349

44-
Compile `Phalcon`:
50+
Compilation
51+
-----------
52+
53+
Follow these instructions to generate a binary extension for your platform:
4554

4655
```bash
47-
cd cphalcon
48-
../zephir/bin/zephir generate
49-
../zephir/bin/zephir compile
56+
git clone git://github.com/phalcon/cphalcon.git
57+
cd cphalcon/build
58+
sudo ./install
5059
```
5160

52-
Add extension to your `php.ini`:
61+
Add the extension to your php.ini:
5362

54-
```ini
63+
```bash
5564
extension=phalcon.so
5665
```
5766

58-
Finally restart the webserver!
67+
Finally, restart the webserver.
5968

6069
External Links
6170
--------------
6271

63-
* [Phalcon Documentation](http://docs.phalconphp.com/)
64-
* [Zephir Documentation](http://zephir-lang.com/)
72+
* [Documentation](http://docs.phalconphp.com/)
73+
* [Support](http://forum.phalconphp.com)
74+
* [Blog](http://blog.phalconphp.com)
75+
* [Zephir](http://zephir-lang.com/)
76+
* [Twitter](http://twitter.com/phalconphp)
6577

6678
Current Build Status
6779
--------------------
6880

69-
Phalcon Framework is built under Travis CI service. Every commit pushed to this repository will queue a build into the continuous integration service and will run all PHPUnit tests to ensure that everything is going well and the project is stable. The current build status is:
81+
Phalcon Framework is built under the Travis CI service. Every commit pushed to this repository will queue a build into the continuous integration service and will run all PHPUnit tests to ensure that everything is going well and the project is stable. The current build status is:
7082

71-
[![Build Status](https://secure.travis-ci.org/phalcon/cphalcon.png?branch=2.0.0)](http://travis-ci.org/phalcon/cphalcon)
83+
[![Build Status](https://secure.travis-ci.org/phalcon/cphalcon.png?branch=master)](http://travis-ci.org/phalcon/cphalcon)
84+
85+
Meet the Incubator
86+
-----------
87+
Our community is developing amazing extra features for Phalcon every day via [Incubator](https://github.com/phalcon/incubator). There are resources to enhance your experience with the framework and that enlarge the main features.
88+
89+
Just give it a try and help us improve Phalcon even more!
7290

7391
License
7492
-------
75-
76-
Phalcon is open-sourced software licensed under the New BSD License. See the docs/LICENSE.txt file for more information.
93+
Phalcon is open source software licensed under the New BSD License. See the docs/LICENSE.txt file for more

0 commit comments

Comments
 (0)