Permalink
Browse files

Using the new syntax highlighting feature in github :)

  • Loading branch information...
whatthejeff committed Apr 19, 2011
1 parent 10c26d5 commit a869e12c40ab17e1ac62242e473cda45ce264b38
Showing with 1,229 additions and 812 deletions.
  1. +77 −63 INSTALL.md
  2. +667 −382 README.md
  3. +8 −5 doc/examples.md
  4. +477 −362 doc/reference.md
View
@@ -3,8 +3,10 @@ INSTALLATION
The easiest way to install the Breeze Framework is with PEAR.
- pear channel-discover pear.breezephp.com
- pear install breeze/Breeze-beta
+``` sh
+pear channel-discover pear.breezephp.com
+pear install breeze/Breeze-beta
+```
If you get a permissions error, you will need to use `su`, `sudo`, or contact your server administrator for help.
@@ -23,33 +25,37 @@ BINARIES
The Breeze Framework comes with a binary called `breeze` which can be used to generate a working project skeleton. If you used the manual installation option, you will need to add the `bin` directory to your `PATH` environmental variable and ensure that you have executable privileges. Afterwards, you can do the following:
- $ breeze myapp
- Your project was successfully created!
- $ find myapp
- myapp
- myapp/controller.php
- myapp/public
- myapp/public/index.php
- myapp/views
- myapp/views/index.php
- myapp/views/layout.php
+``` sh
+$ breeze myapp
+Your project was successfully created!
+$ find myapp
+myapp
+myapp/controller.php
+myapp/public
+myapp/public/index.php
+myapp/views
+myapp/views/index.php
+myapp/views/layout.php
+```
You can also use the `breeze` binary to generate a more complex project structure.
- $ breeze --type complex myapp
- Your project was successfully created!
- $ find myapp
- myapp
- myapp/bootstrap.php
- myapp/controllers
- myapp/controllers/Index.php
- myapp/helpers
- myapp/models
- myapp/public
- myapp/public/index.php
- myapp/views
- myapp/views/index.php
- myapp/views/layout.php
+``` sh
+$ breeze --type complex myapp
+Your project was successfully created!
+$ find myapp
+myapp
+myapp/bootstrap.php
+myapp/controllers
+myapp/controllers/Index.php
+myapp/helpers
+myapp/models
+myapp/public
+myapp/public/index.php
+myapp/views
+myapp/views/index.php
+myapp/views/layout.php
+```
These project structures are only suggestions. You should feel free to structure and configure your projects as you deem fit.
@@ -62,53 +68,61 @@ Unless you intend to run your entire application from a single file (which, by t
### Apache
- RewriteEngine on
- RewriteCond %{REQUEST_FILENAME} !-f
- RewriteCond %{REQUEST_FILENAME} !-d
- RewriteRule .* /index.php
+``` apache
+RewriteEngine on
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule .* /index.php
+```
### nginx
- try_files $uri $uri/ /index.php;
-
- location ~* \.php$ {
- fastcgi_pass 127.0.0.1:8888;
-
- fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
- fastcgi_param QUERY_STRING $query_string;
- fastcgi_param REQUEST_METHOD $request_method;
- fastcgi_param CONTENT_TYPE $content_type;
- fastcgi_param CONTENT_LENGTH $content_length;
- fastcgi_param SERVER_SOFTWARE nginx;
- fastcgi_param SCRIPT_NAME $fastcgi_script_name;
- fastcgi_param REQUEST_URI $request_uri;
- fastcgi_param DOCUMENT_URI $document_uri;
- fastcgi_param DOCUMENT_ROOT $document_root;
- fastcgi_param SERVER_PROTOCOL $server_protocol;
- fastcgi_param REMOTE_ADDR $remote_addr;
- fastcgi_param REMOTE_PORT $remote_port;
- fastcgi_param SERVER_ADDR $server_addr;
- fastcgi_param SERVER_PORT $server_port;
- fastcgi_param SERVER_NAME $server_name;
- }
+``` nginx
+try_files $uri $uri/ /index.php;
+
+location ~* \.php$ {
+ fastcgi_pass 127.0.0.1:8888;
+
+ fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+ fastcgi_param QUERY_STRING $query_string;
+ fastcgi_param REQUEST_METHOD $request_method;
+ fastcgi_param CONTENT_TYPE $content_type;
+ fastcgi_param CONTENT_LENGTH $content_length;
+ fastcgi_param SERVER_SOFTWARE nginx;
+ fastcgi_param SCRIPT_NAME $fastcgi_script_name;
+ fastcgi_param REQUEST_URI $request_uri;
+ fastcgi_param DOCUMENT_URI $document_uri;
+ fastcgi_param DOCUMENT_ROOT $document_root;
+ fastcgi_param SERVER_PROTOCOL $server_protocol;
+ fastcgi_param REMOTE_ADDR $remote_addr;
+ fastcgi_param REMOTE_PORT $remote_port;
+ fastcgi_param SERVER_ADDR $server_addr;
+ fastcgi_param SERVER_PORT $server_port;
+ fastcgi_param SERVER_NAME $server_name;
+}
+```
### lighttpd
- # Note that you will need to parse the query string manually
- # if you use this method.
- #
- # See: http://redmine.lighttpd.net/wiki/lighttpd/FrequentlyAskedQuestions#Whatkindofenvironmentdoesserver.error-handler-404setup
- server.error-handler-404 = "/index.php
+``` lighttpd
+# Note that you will need to parse the query string manually
+# if you use this method.
+#
+# See: http://redmine.lighttpd.net/wiki/lighttpd/FrequentlyAskedQuestions#Whatkindofenvironmentdoesserver.error-handler-404setup
+server.error-handler-404 = "/index.php"
+```
### IIS
- [ISAPI_Rewrite]
+``` apache
+[ISAPI_Rewrite]
- RewriteEngine On
- RewriteBase /
- RewriteCond %{REQUEST_FILENAME} !-f
- RewriteCond %{REQUEST_FILENAME} !-d
- RewriteRule . /index.php [L]
+RewriteEngine On
+RewriteBase /
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule . /index.php [L]
+```
SYSTEM REQUIREMENTS
-------------------
Oops, something went wrong.

0 comments on commit a869e12

Please sign in to comment.