Merge pull request #30 from fazy/readme-update

Updated README to new template, added CONTRIBUTING

CONTRIBUTING.md

@@ -0,0 +1,12 @@
+Contributing
+------------
+
+Symfony2 CMF is an open source, community-driven project. We follow the same
+guidelines as core Symfony2. If you'd like to contribute, please read the
+[Contributing Code][1] part of the documentation. If you're submitting a pull
+request, please follow the guidelines in the [Submitting a Patch][2] section
+and use the [Pull Request Template][3].
+
+[1]: http://symfony.com/doc/current/contributing/code/index.html
+[2]: http://symfony.com/doc/current/contributing/code/patches.html#check-list
+[3]: http://symfony.com/doc/current/contributing/code/patches.html#make-a-pull-request

README.md

@@ -1,65 +1,42 @@
-# Symfony CMF Standard Edition [![Build Status](https://secure.travis-ci.org/symfony-cmf/symfony-cmf-standard.png?branch=master)](http://travis-ci.org/symfony-cmf/symfony-cmf-standard)
+# Symfony CMF Standard Edition
 
-### You will need:
-  * Git 1.6+
-  * PHP 5.3.3+
-  * php5-intl
-  * phpunit 3.6+ (optional)
-  * composer
+[![Build Status](https://secure.travis-ci.org/symfony-cmf/symfony-cmf-standard.png)](http://travis-ci.org/symfony-cmf/symfony-cmf-standard)
+[![Latest Stable Version](https://poser.pugx.org/symfony-cmf/standard-edition/version.png)](https://packagist.org/packages/symfony-cmf/standard-edition)
+[![Total Downloads](https://poser.pugx.org/symfony-cmf/standard-edition/d/total.png)](https://packagist.org/packages/symfony-cmf/standard-edition)
 
-## Get the code
+The Symfony CMF Standard Edition (SE) is a distribution of the
+[Symfony Content Management Framework (CMF)](http://cmf.symfony.com/)
+and licensed under the [MIT License](LICENSE).
 
+This distribution is based on all the main CMF components needed for most common
+use cases, and can be used to create a new Symfony/CMF project from scratch.
 
-    curl -s http://getcomposer.org/installer | php --
-    php composer.phar create-project --stability dev symfony-cmf/standard-edition path/to/install
 
-This will fetch the main project and all it's dependencies.
+## Requirements
 
-The next step is to setup the database, if you want to use Sqlite as your database backend just go ahead and run the following:
+* Symfony 2.3.x
+* See also the `require` section of [composer.json](composer.json)
 
-    app/console doctrine:database:create
-    app/console doctrine:phpcr:init:dbal
-    app/console doctrine:phpcr:repository:init
-    app/console doctrine:phpcr:fixtures:load
 
-If you prefer to use another database backend, for example MySQL, run the Symfony configurator (point your browser 
-to /web/config.php) or set your database connection parameters in app/config/parameters.yml. Make sure you leave
-the 'database_path' property at 'null' in order to use another driver than SQLite. Leaving the field blank in the
-web-configurator should set it to 'null'.
+## Documentation
 
-## Access by web browser
+For the install guide and reference, see:
 
-Create an apache virtual host entry along the lines of
+* [symfony-cmf-standard documentation](http://symfony.com/doc/master/cmf/getting_started/installing_symfony_cmf.html)
 
-    <Virtualhost *:80>
-        Servername symfony-cmf-standard.lo
-        DocumentRoot /path/to/symfony-cmf/symfony-cmf-standard/web
-        <Directory /path/to/symfony-cmf/symfony-cmf-standard>
-            AllowOverride All
-        </Directory>
-    </Virtualhost>
+See also:
 
-And add an entry to your hosts file for "symfony-cmf-standard.lo"
+* [All Symfony CMF documentation](http://symfony.com/doc/master/cmf/index.html) - complete Symfony CMF reference
+* [Symfony CMF Website](http://cmf.symfony.com/) - introduction, live demo, support and community links
 
-If you are running Symfony2 for the first time, run http://symfony-cmf-standard.lo/config.php to ensure your
-system settings have been setup inline with the expected behaviour of the Symfony2 framework.
 
-Then point your browser to http://symfony-cmf-standard.lo/app_dev.php or http://symfony-cmf-standard.lo
+## Contributing
 
-Functional tests are written with PHPUnit. Note that Bundles and Components are tested independently.
+Pull requests are welcome. Please see our [CONTRIBUTING](CONTRIBUTING.md) guide.
 
-    app/console doctrine:phpcr:workspace:create standard_test
-    phpunit -c app
+Unit and/or functional tests exist for this bundle. See the
+[Testing documentation](http://symfony.com/doc/master/cmf/components/testing.html)
+for a guide to running the tests.
 
-## Configuration
-
-You can use the same steps as for the Symfony2 Standard Edition to check and configure the application:
-https://github.com/symfony/symfony-standard#2-checking-your-system-configuration
-
-Note that if you want to improve performance you can enable the caching system:
-https://github.com/symfony-cmf/symfony-cmf-standard/blob/master/app/config/parameters.yml#L10
-
-This will enable caching of storage API lookups into the file system. However it can easily be
-configured to instead use any of the caching backends supported by Doctrine Common and exposed
-by LiipDoctrineCacheBundle:
-https://github.com/liip/LiipDoctrineCacheBundle
+Thanks to
+[everyone who has contributed](https://github.com/symfony-cmf/symfony-cmf-standard/contributors) already.