-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
phalcon
committed
Aug 31, 2012
1 parent
e62d104
commit dca54ee
Showing
1 changed file
with
27 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,30 @@ | ||
Welcome to Phalcon Internals | ||
============================ | ||
|
||
Phalcon is not a traditional framework, is written as an extension C to provide high performance. The purpose of this document is to explain how it is built internally. If you're interested in helping to improve Phalcon, this is the information you need. | ||
Phalcon is not a traditional framework, is written as an extension C to provide high performance. The purpose of this document is to explain how it is built internally. If you're interested in helping to improve Phalcon, this is the information you need. | ||
|
||
## Information | ||
|
||
This is the repository for the Phalcon PHP Internals documentation. Our documentation is | ||
hosted on Read The Docs (http://www.readthedocs.org) which is automatically | ||
updated when any changes are made to this repository. | ||
|
||
You are welcome to fork this repository and add, correct, enhance the | ||
documentation yourselves. | ||
|
||
The documentation language is reStructuredText (http://sphinx.pocoo.org/rest.html) | ||
|
||
## Installing Sphinx | ||
|
||
If you have already installed Python, just execute the following command: | ||
|
||
easy_install -U Sphinx | ||
|
||
## Compiling the docs | ||
|
||
If you have installed Sphinx, execute the following command: | ||
|
||
make html | ||
|
||
The _build directory is produced, open it on your browser: http://localhost/docs-internals/_build/html/ | ||
|