Skip to content

Commit 12b565d

Browse files
Ankit098francisf
authored andcommitted
chore: update README
1 parent 56d73ae commit 12b565d

1 file changed

Lines changed: 25 additions & 3 deletions

File tree

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,36 @@
44

55
![BrowserStack Logo](https://d98b8t1nnulk5.cloudfront.net/production/images/layout/logo-header.png?1469004780)
66

7+
## Prerequisites
8+
9+
1. Make sure that you have **PHP** installed on your system. You can download and install **PHP** using following commands in the terminal:
10+
11+
* **MacOS:**
12+
```bash
13+
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
14+
brew install php
15+
```
16+
* **Windows:**
17+
```bash
18+
sudo apt-get install curl libcurl3 libcurl3-dev php
19+
```
20+
**Note:** For **Windows**, you can download **PHP** from [here](http://windows.php.net/download/). Also, refer to this [documentation](http://php.net/manual/en/install.windows.php) for ensuring the accessibility of PHP through the Command Prompt.
21+
22+
2. Download **composer** in the project directory ([Linux/MacOS](https://getcomposer.org/download/), [Windows](https://getcomposer.org/doc/00-intro.md#installation-windows)).
23+
24+
**Note:** To use the **composer** command directly, it either should have been downloaded in the project directory or should be accessible globally which can be done by the command below:
25+
```bash
26+
mv composer.phar /usr/local/bin/composer
27+
```
28+
729
## Setup
830
* Clone the repo
9-
* Install dependencies `composer install`
31+
* Install dependencies using: `composer install`
1032
* Update `test.conf.json` file inside the `config/` directory with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings)
1133

1234
## Running your tests
13-
* To run tests, run `composer test`
14-
* To run local tests, run `composer local`
35+
* To run tests, run: `composer test`
36+
* To run local tests, run: `composer local`
1537

1638
Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
1739

0 commit comments

Comments
 (0)