Unverified Commit fb700843 authored by Matheus Felipe's avatar Matheus Felipe
Browse files

Create install dependencies section

parent 1c3e4eba
...@@ -16,6 +16,16 @@ scripts ...@@ -16,6 +16,16 @@ scripts
links.py links.py
``` ```
## Install dependencies
You must have [python](https://www.python.org/) installed to use these scripts.
it is also necessary to install the validation package dependencies, use [pip package manager](https://pypi.org/project/pip/) for this:
```bash
$ python -m pip install -r scripts/requirements.txt
```
## Run validations ## Run validations
To run format validation on the `README.md` file, being in the root directory of public-apis, run: To run format validation on the `README.md` file, being in the root directory of public-apis, run:
...@@ -55,5 +65,3 @@ To run only the links tests, run: ...@@ -55,5 +65,3 @@ To run only the links tests, run:
```bash ```bash
$ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py" $ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py"
``` ```
*Note that it is necessary to have [python](https://www.python.org/) installed.*
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment