Browse files

Updated README

  • Loading branch information...
1 parent 53d84f9 commit fffbb4a8c846cfe1e3616b05aa4ed76e4ce73586 @willdurand willdurand committed Nov 10, 2011
Showing with 21 additions and 6 deletions.
  1. +21 −6 README.md
View
27 README.md
@@ -15,10 +15,27 @@ Propel2 is only supported on PHP 5.3.2 and up.
## Installation ##
-_// Not yet documented._
+Read the [Propel documentation](http://www.propelorm.org/).
-## Running unit tests ##
+## Contribute ##
+
+Everybody can contribute to Propel2. Just fork it, and send Pull Requests.
+You have to follow [Propel2 Coding Standards](http://github.com/propelorm/Propel2/issues/2) and provides unit tests as much as possible.
+
+**Note:** you can fix checkstyle before to submit a Pull Request by using the Symfony2 `check_cs` script.
+You just need to install [Finder](http://github.com/symfony/Finder) and the script:
+
+ git clone git://github.com/symfony/Finder.git vendor/Symfony/Component/Finder
+
+ wget https://raw.github.com/symfony/symfony/master/check_cs
+
+Then use it:
+
+ php check_cs fix
+
+
+## Unit Tests ##
To run unit tests, you'll have to install vendors:
@@ -28,11 +45,9 @@ Once done, build fixtures:
./tests/reset_tests.sh
-Now you can run unit tests for both `Generator/` and `Runtime/`:
-
- phpunit -c phpunit.xml.dist tests/Propel/Tests/Generator/
+Now you can run unit tests:
- phpunit -c phpunit.xml.dist tests/Propel/Tests/Runtime/
+ phpunit
## License ##

0 comments on commit fffbb4a

Please sign in to comment.