Skip to content

Commit 3942250

Browse files
authored
Merge pull request #18 from equinix-labs/fix_docs
docs: add prerequisites into root README.md
2 parents 87d8c1a + 26f7c22 commit 3942250

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,20 @@ This repository contains a collection of Terraform modules to help automate the
1010

1111
This project is intended to be used as a Terraform module. It may also be forked, cloned, or downloaded and modified as needed as the base in your integrations and deployments.
1212

13-
Prerequesites:
13+
Prerequisites:
1414

1515
* A valid Equinix Metal organization ID, API token, and/or project ID.
1616
* HashiCorp Terraform installed. Please see [tfenv](https://github.com/tfutils/tfenv) util.
17-
* Optional [metal-cli](https://github.com/equinix/metal-cli/#installation) installation.
17+
18+
Optional:
19+
20+
* Install [pre-commit](https://pre-commit.com/#install) with its prerequisites: [python](https://docs.python.org/3/using/unix.html#getting-and-installing-the-latest-version-of-python) and [pip](https://pip.pypa.io/en/stable/installation/).
21+
* Install required packages: [tflint](https://github.com/terraform-linters/tflint), [tfsec](https://aquasecurity.github.io/tfsec/v1.0.11/getting-started/installation/), [shfmt](https://github.com/mvdan/sh), [shellcheck](https://github.com/koalaman/shellcheck), and [markdownlint](https://github.com/markdownlint/markdownlint).
22+
* Install [metal-cli](https://github.com/equinix/metal-cli/#installation).
23+
24+
To initialize pre-commit: `pre-commit install`.
25+
26+
Run `terraform init -upgrade` and `terraform apply`.
1827

1928
## Examples
2029

0 commit comments

Comments
 (0)