Skip to content

Commit

Permalink
Using the new syntax highlighting feature in github :)
Browse files Browse the repository at this point in the history
  • Loading branch information
whatthejeff committed Apr 19, 2011
1 parent 10c26d5 commit a869e12
Show file tree
Hide file tree
Showing 4 changed files with 1,229 additions and 812 deletions.
140 changes: 77 additions & 63 deletions INSTALL.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ INSTALLATION


The easiest way to install the Breeze Framework is with PEAR. The easiest way to install the Breeze Framework is with PEAR.


pear channel-discover pear.breezephp.com ``` sh
pear install breeze/Breeze-beta 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. If you get a permissions error, you will need to use `su`, `sudo`, or contact your server administrator for help.


Expand All @@ -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: 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 ``` sh
Your project was successfully created! $ breeze myapp
$ find myapp Your project was successfully created!
myapp $ find myapp
myapp/controller.php myapp
myapp/public myapp/controller.php
myapp/public/index.php myapp/public
myapp/views myapp/public/index.php
myapp/views/index.php myapp/views
myapp/views/layout.php myapp/views/index.php
myapp/views/layout.php
```


You can also use the `breeze` binary to generate a more complex project structure. You can also use the `breeze` binary to generate a more complex project structure.


$ breeze --type complex myapp ``` sh
Your project was successfully created! $ breeze --type complex myapp
$ find myapp Your project was successfully created!
myapp $ find myapp
myapp/bootstrap.php myapp
myapp/controllers myapp/bootstrap.php
myapp/controllers/Index.php myapp/controllers
myapp/helpers myapp/controllers/Index.php
myapp/models myapp/helpers
myapp/public myapp/models
myapp/public/index.php myapp/public
myapp/views myapp/public/index.php
myapp/views/index.php myapp/views
myapp/views/layout.php 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. These project structures are only suggestions. You should feel free to structure and configure your projects as you deem fit.


Expand All @@ -62,53 +68,61 @@ Unless you intend to run your entire application from a single file (which, by t


### Apache ### Apache


RewriteEngine on ``` apache
RewriteCond %{REQUEST_FILENAME} !-f RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule .* /index.php RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule .* /index.php
```


### nginx ### nginx


try_files $uri $uri/ /index.php; ``` nginx

try_files $uri $uri/ /index.php;
location ~* \.php$ {
fastcgi_pass 127.0.0.1:8888; 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 SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param REQUEST_METHOD $request_method; fastcgi_param QUERY_STRING $query_string;
fastcgi_param CONTENT_TYPE $content_type; fastcgi_param REQUEST_METHOD $request_method;
fastcgi_param CONTENT_LENGTH $content_length; fastcgi_param CONTENT_TYPE $content_type;
fastcgi_param SERVER_SOFTWARE nginx; fastcgi_param CONTENT_LENGTH $content_length;
fastcgi_param SCRIPT_NAME $fastcgi_script_name; fastcgi_param SERVER_SOFTWARE nginx;
fastcgi_param REQUEST_URI $request_uri; fastcgi_param SCRIPT_NAME $fastcgi_script_name;
fastcgi_param DOCUMENT_URI $document_uri; fastcgi_param REQUEST_URI $request_uri;
fastcgi_param DOCUMENT_ROOT $document_root; fastcgi_param DOCUMENT_URI $document_uri;
fastcgi_param SERVER_PROTOCOL $server_protocol; fastcgi_param DOCUMENT_ROOT $document_root;
fastcgi_param REMOTE_ADDR $remote_addr; fastcgi_param SERVER_PROTOCOL $server_protocol;
fastcgi_param REMOTE_PORT $remote_port; fastcgi_param REMOTE_ADDR $remote_addr;
fastcgi_param SERVER_ADDR $server_addr; fastcgi_param REMOTE_PORT $remote_port;
fastcgi_param SERVER_PORT $server_port; fastcgi_param SERVER_ADDR $server_addr;
fastcgi_param SERVER_NAME $server_name; fastcgi_param SERVER_PORT $server_port;
} fastcgi_param SERVER_NAME $server_name;
}
```


### lighttpd ### lighttpd


# Note that you will need to parse the query string manually ``` lighttpd
# if you use this method. # 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 # See: http://redmine.lighttpd.net/wiki/lighttpd/FrequentlyAskedQuestions#Whatkindofenvironmentdoesserver.error-handler-404setup
server.error-handler-404 = "/index.php"
```


### IIS ### IIS


[ISAPI_Rewrite] ``` apache
[ISAPI_Rewrite]
RewriteEngine On RewriteEngine On
RewriteBase / RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L] RewriteRule . /index.php [L]
```


SYSTEM REQUIREMENTS SYSTEM REQUIREMENTS
------------------- -------------------
Expand Down
Loading

0 comments on commit a869e12

Please sign in to comment.