Commit cb303871 authored by Fabien Potencier's avatar Fabien Potencier

moved README to rst

parent 282628dc
Silex, a simple Web Framework
=============================
Silex is a PHP micro-framework to develop websites based on [Symfony2][1]
components:
```php
<?php
require_once __DIR__.'/../vendor/autoload.php';
$app = new Silex\Application();
$app->get('/hello/{name}', function ($name) use ($app) {
return 'Hello '.$app->escape($name);
});
$app->run();
```
Silex works with PHP 5.3.3 or later.
## Installation
The recommended way to install Silex is [through
composer](http://getcomposer.org). Just create a `composer.json` file and
run the `php composer.phar install` command to install it:
{
"require": {
"silex/silex": "~1.1"
}
}
Alternatively, you can download the [`silex.zip`][2] file and extract it.
## More Information
Read the [documentation][3] for more information.
## Tests
To run the test suite, you need [composer](http://getcomposer.org).
$ php composer.phar install --dev
$ vendor/bin/phpunit
## Community
Check out #silex-php on irc.freenode.net.
## License
Silex is licensed under the MIT license.
[1]: http://symfony.com
[2]: http://silex.sensiolabs.org/download
[3]: http://silex.sensiolabs.org/documentation
Silex, a simple Web Framework
=============================
Silex is a PHP micro-framework to develop websites based on `Symfony2
components`_:
.. code-block:: php
<?php
require_once __DIR__.'/../vendor/autoload.php';
$app = new Silex\Application();
$app->get('/hello/{name}', function ($name) use ($app) {
return 'Hello '.$app->escape($name);
});
$app->run();
Silex works with PHP 5.3.3 or later.
Installation
------------
The recommended way to install Silex is through `Composer`_. Just create a
``composer.json`` file and run the ``php composer.phar install`` command to
install it:
.. code-block:: json
{
"require": {
"silex/silex": "~1.1"
}
}
Alternatively, you can download the `silex.zip`_ file and extract it.
More Information
----------------
Read the `documentation`_ for more information.
Tests
-----
To run the test suite, you need `Composer`_:
.. code-block:: bash
$ php composer.phar install --dev
$ vendor/bin/phpunit
Community
---------
Check out #silex-php on irc.freenode.net.
License
-------
Silex is licensed under the MIT license.
.. _Symfony2 components: http://symfony.com
.. _Composer: http://getcomposer.org
.. _silex.zip: http://silex.sensiolabs.org/download
.. _documentation: http://silex.sensiolabs.org/documentation
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment