Merge pull request doctrine#5623 from Jean85/patch-1

Ocramius · web-flow · commit af1ea1ae1d4f · 2017-06-22T08:03:42.000+02:00
[DOCUMENTATION] Update tests README
diff --git a/tests/README.markdown b/tests/README.markdown
@@ -1,8 +1,25 @@
 # Running the Doctrine 2 Testsuite
 
-## Setting up a PHPUnit Configuration XML
+To execute the Doctrine2 testsuite, you just need to execute this simple steps:
 
-..
+ * Clone the project from GitHub
+ * Enter the Doctrine2 folder
+ * Install the dependencies
+ * Execute the tests
+ 
+ All this is (normally) done with:
+
+    git clone git@github.com:doctrine/doctrine2.git
+    cd doctrine2
+    composer install
+    ./vendor/bin/phpunit
+
+## Pre-requisites
+Doctrine2 works on many database vendors; the tests can detect the presence of installed vendors, but you need at least one of those; the easier to install is SQLite.
+
+If you're using Debian, or a Debian-derivate Linux distribution (like Ubuntu), you can install SQLite with:
+
+    sudo apt-get install sqlite
 
 ## Testing Lock-Support
 
@@ -14,12 +31,12 @@ Install Gearman with PHP as follows:
 3. Start it up "gearmand -vvvv"
 4. Install pecl/gearman by calling "gearman-beta"
 
-You can then go into tests/ and start up two workers:
+You can then go into `tests/` and start up two workers:
 
     php Doctrine/Tests/ORM/Functional/Locking/LockAgentWorker.php
 
 Then run the locking test-suite:
 
     phpunit --configuration <myconfig.xml> Doctrine/Tests/ORM/Functional/Locking/GearmanLockTest.php
 
-This can run considerable time, because it is using sleep() to test for the timing ranges of locks.
+This can run considerable time, because it is using sleep() to test for the timing ranges of locks.
