diff --git a/README.md b/README.md index 9ab2dab..1c8ff7a 100644 --- a/README.md +++ b/README.md @@ -19,19 +19,40 @@ $ vendor/bin/robo run:tests You need to install: - Git for windows (https://msysgit.github.io/) - GitHub for windows (https://windows.github.com/) -- Curl for windows if necesssary. +- Curl for Windows if necesssary. Note: For commands line is better if you use the 'Git shell' program. -Create a symbolic link from your tests\joomla-cms3 to a subfolder of your web server. For example, I'm creating a link between the tests folder of my weblinks folder and the tests folder of my web server: -mklink /J C:\wamp\www\tests\joomla-cms3 C:\Users\Nicolas\Documents\GitHub\weblinks\tests\joomla-cms3 +First you should create a fork of the official repository and clone the fork into your web server folder. -Go in the folder of weblinks, for example: -cd C:\Users\Nicolas\Documents\GitHub\weblinks +To prepare the system tests (Selenium) to be run in your local machine you are asked to rename the file `tests/acceptance.suite.dist.yml` to `tests/acceptance.suite.yml`. Afterwards, please edit the file according to your system needs. -Then, run the command: -composer install +The next step is only required if you don't place the weblinks folder into your web server folder. Create a symbolic link from your tests\joomla-cms3 to a subfolder of your web server. For example: -That will add all the dependencies for the testing of weblinks -You can then run the command: -vendor\bin\robo.bat test:acceptance +```bash +mklink /J C:\wamp\www\tests\joomla-cms3 C:\Users\Name\Documents\GitHub\weblinks\tests\joomla-cms3 +``` + +Open the console and go in the folder of weblinks, for example: + +```bash +cd C:\wamp\www\weblinks +``` + +Then run the command: + +```bash +$ composer install +``` + +You can then run the following command to start the tests: + +```bash +$ vendor/bin/robo run:tests +``` + +Once all tests were executed, you may also run a specific test: + +```bash +$ vendor/bin/robo run:test // Then select the test you want to run! +``` \ No newline at end of file