Permalink
Browse files

Updated README

  • Loading branch information...
1 parent f33aa61 commit b52f1fea01ac384aca08e79b8a9baf0587f0995f @willdurand willdurand committed Aug 22, 2011
Showing with 20 additions and 19 deletions.
  1. +20 −19 README.md
View
@@ -16,7 +16,7 @@ Clone the plugin from Github:
If you use Git as a VCS for your project, it should be better to add the plugin as a submodule:
git submodule add git://github.com/propelorm/sfPropelORMPlugin.git plugins/sfPropelORMPlugin
- git submodule init --update --recursive
+ git submodule update --init --recursive
As both Phing and Propel libraries are bundled with the plugin, you have to initialize submodules for the plugin.
@@ -28,43 +28,44 @@ Install the plugin via the subversion repository:
Install `Phing` and `Propel`:
- cd lib/vendor
- svn checkout http://phing.mirror.svn.symfony-project.com/tags/2.3.3/classes/phing phing
- svn checkout http://svn.github.com/propelorm/Propel.git propel
+ svn checkout http://phing.mirror.svn.symfony-project.com/tags/2.3.3/classes/phing lib/vendor/phing
+ svn checkout http://svn.github.com/propelorm/Propel.git lib/vendor/propel
-Optional: add a reference to the propel and phing folders in the test project:
+### Final step
+
+Disable the core Propel plugin and enable the `sfPropelORMPlugin` instead:
``` php
-// plugins/sfPropelORMPlugin/test/functional/fixtures/config/ProjectConfiguration.class.php
+// config/ProjectConfiguration.class.php
class ProjectConfiguration extends sfProjectConfiguration
{
public function setup()
{
- $this->enablePlugins(array('sfPropelORMPlugin'));
- $this->setPluginPath('sfPropelORMPlugin', realpath(dirname(__FILE__) . '/../../../..'));
- sfConfig::set('sf_phing_path', SF_DIR.'/../phing');
- sfConfig::set('sf_propel_path', SF_DIR.'/../propel');
+ // If you're following the SVN way, uncomment the next two lines
+ //sfConfig::set('sf_phing_path', sfConfig::get('sf_root_dir').'/lib/vendor/phing');
+ //sfConfig::set('sf_propel_path', sfConfig::get('sf_root_dir').'/lib/vendor/propel');
+
+ $this->enablePlugins('sfPropelORMPlugin');
}
+}
```
-### Final step
-
-Disable the core Propel plugin and enable the `sfPropelORMPlugin` instead:
+**Optional:** update references to the `propel` and `phing` folders in the test project.
``` php
-// config/ProjectConfiguration.class.php
+// plugins/sfPropelORMPlugin/test/functional/fixtures/config/ProjectConfiguration.class.php
class ProjectConfiguration extends sfProjectConfiguration
{
public function setup()
{
- $this->enablePlugins('sfPropelORMPlugin');
- // If you're following the SVN way, uncomment the next two lines
- //sfConfig::set('sf_phing_path', sfConfig::get('sf_root_dir').'/lib/vendor/phing');
- //sfConfig::set('sf_propel_path', sfConfig::get('sf_root_dir').'/lib/vendor/propel');
+ $this->enablePlugins(array('sfPropelORMPlugin'));
+ $this->setPluginPath('sfPropelORMPlugin', realpath(dirname(__FILE__) . '/../../../..'));
+
+ sfConfig::set('sf_phing_path', SF_DIR.'/../phing');
+ sfConfig::set('sf_propel_path', SF_DIR.'/../propel');
}
-}
```
Right after the installation of the plugin, you should update plugin assets:

0 comments on commit b52f1fe

Please sign in to comment.