Skip to content

Commit 21e981b

Browse files
author
tro
authored
Merge pull request #60 from aws4embeddedlinux/2023-11-23_add_note_about_node
README.md: add note about node versions
2 parents 0201170 + b8a92d8 commit 21e981b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ This [cdk](https://github.com/aws/aws-cdk) IaC library helps you to deploy AWS c
99
[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc`
1010

1111
# Setting Up
12+
In order to use this library, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
13+
installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.
14+
15+
> [!NOTE]
16+
> This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend
17+
> using [NVM](https://github.com/nvm-sh/nvm) to install a compatible version
1218
1319
## Quickstart
1420
Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo.

0 commit comments

Comments
 (0)