Merge pull request #51 from aws4embeddedlinux/setup-guide

Start the setup guide.

README.md

@@ -1,33 +1,51 @@
-## aws4embeddedlinux-ci
+# aws4embeddedlinux-ci
 
 This [cdk](https://github.com/aws/aws-cdk) IaC library help you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.
 
-### Architecture
+## Architecture
 ![architecture overview](architecture.drawio.svg "Architecture")
 
-### Quickstart
+## API documentation
+[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc`
+
+# Setting Up
+
+## Quickstart
 Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo.
 
-### API documentation
-[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc`
 
-### Development Setup
+## Setting Up A New Project
+
+1. Create a CDK project. More details can be found in the [CDK Getting Started Documentation](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html).
+```
+mkdir my-project
+cd my-project
+cdk init app --language typescript
+```
+2. Add the cdk library with `npm install aws4embeddedlinux/aws4embeddedlinux-ci`
+3. Create your application using the library. Refer to the [API Documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci) and the [Examples](github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) for more details.
+4. Deploy your application using `cdk deploy`.
+5. After the application is deployed, the 'Build Image' Pipeline needs to be run. This will create an Ubuntu based container for building Yocto. This container is used by the other pipelines. If the other pipelines are run before this container is created and pushed to [ECR](https://aws.amazon.com/ecr/), they will fail. This Build Image Pipeline will run weekly by default to keep this container patched.
+6. Now the application pipeline is able to be run. This will push contents of the Yocto deploy directory into S3.
+
+## Development Setup
 You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a local copy of this repo.
 
-#### In this library repo:
+### In this library repo:
 ```bash
 $ npm link
 $ cd your-project
 ```
 
-#### In your-project folder:
+### In your-project folder:
 ```bash
 $ npm link aws4embeddedlinux-ci
 ```
 
 This will link through the system `node_modules` install. When using a system node install on Linux, this can require sudo access. To avoid this, use a [node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm) or [set a node prefix](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
 
 
+
 ## Security
 
 See [SECURITY](SECURITY.md) for more information about reporting issues with this project.