Skip to content

Commit

Permalink
updates to README in Resources/CDK folder
Browse files Browse the repository at this point in the history
  • Loading branch information
brmur committed Feb 2, 2021
1 parent 976175d commit d47bdc4
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions tools/cdk_app_template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,6 @@ To merge your finished AWS CDK app's source code, merge **only** the following f

**Important**: Update the [README.md in the resources/cdk folder of the AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/master/resources/cdk) with a description of the resources that your AWS CDK app provisions.

**Do not** merge the following folders or files from your development machine into the repository:

* ``node_modules/``
* ``package-lock.json``
* This version of the ``README.md`` file

This is especially important for the ``node_modules/`` folder, as it could grow to several hundred megabytes or more in size during development. The ``.gitignore`` file in this folder contains a list of these folders and files.

You can regenerate these unmerged folders and files on your development machine as needed by running the preceding ``npm`` and ``cdk`` commands on your development machine (after of course installing the AWS CDK prerequisites).

Merge the ``CloudFormation.yaml`` file into the same location(s) as any code example file(s) with which this ``CloudFormation.yaml`` file is intended to be used.
Expand Down

0 comments on commit d47bdc4

Please sign in to comment.