Skip to content

Commit dca54ee

Browse files
author
phalcon
committed
Updating README
1 parent e62d104 commit dca54ee

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,30 @@
11
Welcome to Phalcon Internals
22
============================
33

4-
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.
4+
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.
5+
6+
## Information
7+
8+
This is the repository for the Phalcon PHP Internals documentation. Our documentation is
9+
hosted on Read The Docs (http://www.readthedocs.org) which is automatically
10+
updated when any changes are made to this repository.
11+
12+
You are welcome to fork this repository and add, correct, enhance the
13+
documentation yourselves.
14+
15+
The documentation language is reStructuredText (http://sphinx.pocoo.org/rest.html)
16+
17+
## Installing Sphinx
18+
19+
If you have already installed Python, just execute the following command:
20+
21+
easy_install -U Sphinx
22+
23+
## Compiling the docs
24+
25+
If you have installed Sphinx, execute the following command:
26+
27+
make html
28+
29+
The _build directory is produced, open it on your browser: http://localhost/docs-internals/_build/html/
30+

0 commit comments

Comments
 (0)