Browse Source

Create install dependencies section

pull/3011/head
Matheus Felipe 2 years ago
parent
commit
fb70084377
No known key found for this signature in database GPG Key ID: AA785C523274872F
1 changed files with 10 additions and 2 deletions
  1. +10
    -2
      scripts/README.md

+ 10
- 2
scripts/README.md View File

@@ -16,6 +16,16 @@ scripts
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

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:
```bash
$ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py"
```

*Note that it is necessary to have [python](https://www.python.org/) installed.*

Loading…
Cancel
Save