From 8007d8557f61abac6983ae66867739cb212490b0 Mon Sep 17 00:00:00 2001 From: Lars Janssen Date: Mon, 5 Aug 2013 16:16:51 +0100 Subject: [PATCH 1/3] Updated README to new template, added CONTRIBUTING --- CONTRIBUTING.md | 12 ++++++++ README.md | 73 ++++++++++++++++--------------------------------- 2 files changed, 36 insertions(+), 49 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e4efab --- /dev/null +++ b/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 diff --git a/README.md b/README.md index af0eeed..810e3cc 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,40 @@ -# 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/symfony-cmf-standard/version.png)](https://packagist.org/packages/symfony-cmf/symfony-cmf-standard) +[![Total Downloads](https://poser.pugx.org/symfony-cmf/symfony-cmf-standard/d/total.png)](https://packagist.org/packages/symfony-cmf/symfony-cmf-standard) -## Get the code +This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/) +and licensed under the [MIT License](LICENSE). +The Symfony CMF Standard Edition (SE) is a distribution of the CMF based on all +the main components needed for most common use cases. - curl -s http://getcomposer.org/installer | php -- - php composer.phar create-project --stability dev symfony-cmf/standard-edition path/to/install +## Requirements -This will fetch the main project and all it's dependencies. +* Symfony 2.3.x +* See also the `require` section of [composer.json](composer.json) -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: - app/console doctrine:database:create - app/console doctrine:phpcr:init:dbal - app/console doctrine:phpcr:repository:init - app/console doctrine:phpcr:fixtures:load +## Documentation -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'. +For the install guide and reference, see: -## Access by web browser +* [symfony-cmf-standard documentation](http://symfony.com/doc/master/cmf/getting_started/installing_symfony_cmf.html) -Create an apache virtual host entry along the lines of +See also: - - Servername symfony-cmf-standard.lo - DocumentRoot /path/to/symfony-cmf/symfony-cmf-standard/web - - AllowOverride All - - +* [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 -And add an entry to your hosts file for "symfony-cmf-standard.lo" -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. +## Contributing -Then point your browser to http://symfony-cmf-standard.lo/app_dev.php or http://symfony-cmf-standard.lo +Pull requests are welcome. Please see our [CONTRIBUTING](CONTRIBUTING.md) guide. -Functional tests are written with PHPUnit. Note that Bundles and Components are tested independently. +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. - app/console doctrine:phpcr:workspace:create standard_test - phpunit -c app - -## 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. From 4a735b8f9fe7a50a6e253e6541d3e25530887c75 Mon Sep 17 00:00:00 2001 From: Lars Janssen Date: Mon, 5 Aug 2013 16:21:57 +0100 Subject: [PATCH 2/3] Fixed packagist links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 810e3cc..242f0d7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Symfony CMF Standard Edition [![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/symfony-cmf-standard/version.png)](https://packagist.org/packages/symfony-cmf/symfony-cmf-standard) -[![Total Downloads](https://poser.pugx.org/symfony-cmf/symfony-cmf-standard/d/total.png)](https://packagist.org/packages/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) This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/) and licensed under the [MIT License](LICENSE). From fa45e574d820f7e514aaa048da598ff8a7c69d6a Mon Sep 17 00:00:00 2001 From: Lars Janssen Date: Tue, 6 Aug 2013 11:06:24 +0100 Subject: [PATCH 3/3] Updated README to clarify the type/purpose of this project --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 242f0d7..47499b5 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,13 @@ [![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) -This bundle is part of the [Symfony Content Management Framework (CMF)](http://cmf.symfony.com/) +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). -The Symfony CMF Standard Edition (SE) is a distribution of the CMF based on all -the main components needed for most common use cases. +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. + ## Requirements