Skip to content

Commit 6e5b9ac

Browse files
committed
Readme proofreading updates.
1 parent 9abd6df commit 6e5b9ac

File tree

1 file changed

+32
-20
lines changed

1 file changed

+32
-20
lines changed

README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
## Getting Started
44
This repository shows ways to use the [aws4embeddedlinux-ci](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci.git) library.
55

6-
In order to use these examples, you must setup [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html) including installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.
6+
In order to use these examples, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
7+
installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.
78

89
### Clone and Setup NPM Project
910
```bash
@@ -13,17 +14,20 @@ npm install .
1314
npm run build
1415
```
1516

16-
Note that while often CDK projects do not require separately invoking the build command, this will ensure various assets in the library are packaged correctly.
17+
Note that while the CDK projects often do not require that you invoke the build command separately, doing so will ensure various assets
18+
in the library are packaged correctly.
1719

1820
### Deploying
1921

2022
To deploy _all_ the pipeline examples, you can use the CDK deploy command:
2123

2224
```bash
23-
cdk deploy --all --require-approval never
25+
cdk deploy --all
2426
```
2527

26-
The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other pipelines will work correctly. Once it is complete, the EmbeddedLinuxPipeline in the CodePipeline console page is ready to run.
28+
The pipelines can be found in the `Developer Tools > Code Pipeline > Pipelines` Console page. The newly created
29+
pipeline `ubuntu_22_04BuildImagePipeline` should start automatically. If not, it will need to be run before other
30+
pipelines will work correctly. Once it is complete, the EmbeddedLinuxPipeline in the CodePipeline console page is ready to run.
2731

2832
### Removing Pipelines
2933
The `cdk destroy` command can be used to remove individual pipelines and their related resources. This can also be done in the CloudFormation Console Page.
@@ -39,25 +43,32 @@ Several example pipelines are provided. Each one demonstrates a different aspect
3943
### A Simple Poky Based Pipeline
4044
This example will build the `core-image-minimal` image from Poky using the repo tool to manage layers. CVE checking is also enabled in the buildspec file.
4145

42-
The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-` followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, CodeBuild Project (with build logs), and the S3 bucket that the image is uploaded to at the end.
46+
The recommended place to view this is from the `Developer Tools > Code Pipeline > Pipelines` page. The pipeline will start with `PokyPipeline-`
47+
followed by some unique identifier. From the pipeline page, you can find the CodeCommit source repository, the CodeBuild Project (with build logs),
48+
and the S3 bucket that the image is uploaded to, at the end.
4349

4450
#### Using Kas
45-
The Kas example shows how to use a [Kas Config](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci/blob/main/source-repo/kas/kas.yml) to manage layers. This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
51+
The Kas example shows how to use a [Kas Config](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci/blob/main/source-repo/kas/kas.yml) to manage
52+
layers. This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
4653

47-
See AWS CodeBuild pipeline: KasPipeline-EmbeddedLinuxPipeline*
54+
See the AWS CodeBuild pipeline: KasPipeline-EmbeddedLinuxPipeline*
4855

4956
#### A slightly modified version building a qemu pipeline:
50-
This example builds a Qemu based image using [meta-aws-demos](https://github.com/aws4embeddedlinux/meta-aws-demos). The Qemu image can be run in the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing) such as ptest can be run in the pipeline.
57+
This example builds a Qemu based image using [meta-aws-demos](https://github.com/aws4embeddedlinux/meta-aws-demos). The Qemu image can be run in
58+
the CodeBuild environment. Using SLIRP networking, [OEQA testing](https://docs.yoctoproject.org/singleindex.html#performing-automated-runtime-testing)
59+
such as ptest can be run in the pipeline.
5160

52-
See AWS CodeBuild pipeline: QemuEmbeddedLinuxPipeline-EmbeddedLinuxPipeline*
61+
See the AWS CodeBuild pipeline: QemuEmbeddedLinuxPipeline-EmbeddedLinuxPipeline*
5362

5463
### A Poky Based EC2 AMI Pipeline
55-
Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using the [VM Import/Export Service](https://docs.aws.amazon.com/vm-import/latest/userguide/what-is-vmimport.html).
64+
Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using
65+
the [VM Import/Export Service](https://docs.aws.amazon.com/vm-import/latest/userguide/what-is-vmimport.html).
5666

5767
The pipeline name starts with `PokyAmiPipeline-` in the CodePipeline page.
5868

5969
### A NXP / IMX Pipeline
60-
This example will build an image for the [i.MX 6ULL EVK](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/evaluation-kit-for-the-i-mx-6ull-and-6ulz-applications-processor:MCIMX6ULL-EVK) board.
70+
This example will build an image for
71+
the [i.MX 6ULL EVK](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/evaluation-kit-for-the-i-mx-6ull-and-6ulz-applications-processor:MCIMX6ULL-EVK) board.
6172

6273
Accepting the EULA is required. For this you need to uncomment the
6374
```
@@ -69,27 +80,28 @@ The pipeline name starts with `NxpImxPipeline-` in the CodePipeline page.
6980

7081
### Using pre-built, proprietary artifacts in a Pipeline
7182

72-
This example is based on this [work](https://elinux.org/R-Car/Boards/Yocto-Gen3/v5.9.0) to build an image for Renesas R-Car-H3 Starter Kit Premier (unofficial name - H3ULCB) board including the proprietary graphics and multimedia drivers from Renesas.
83+
This example is based on this [work](https://elinux.org/R-Car/Boards/Yocto-Gen3/v5.9.0) to build an image for Renesas R-Car-H3 Starter Kit
84+
Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.
7385

74-
You need to download Multimedia and Graphics library and related Linux drivers, please from the following link (registration necessary):
86+
Download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):
7587
https://www.renesas.com/us/en/application/automotive/r-car-h3-m3-h2-m2-e2-documents-software
7688

7789
#### Download two files:
7890

79-
R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-20220121.zip
80-
R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-20220121.zip
91+
- R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-20220121.zip
92+
- R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-20220121.zip
8193

8294
Graphic drivers are required for Wayland. Multimedia drivers are optional.
8395

8496
#### Steps to build the image
8597

86-
Create a folder named `proprietary` in the root of the source repo. Put those two downloaded files into this folder. After you did deploy the build pipeline and uncomment the `#TODO` in the build.sh file.
98+
1. Create a folder named `proprietary` in the root of the source repo, and put those two downloaded files into this folder.
99+
1. Deploy the build pipeline and uncomment the `#TODO` in the build.sh file.
100+
1. A build should automatically start. Once it succeeds you will get an image containing the proprietary graphics and multimedia drivers.
87101

88-
Now a build should automatically start, succeed and you will get an image containing the proprietary graphics and multimedia drivers.
102+
See the AWS CodeBuild pipeline: RenesasPipeline-EmbeddedLinuxPipeline*
89103

90-
See AWS CodeBuild pipeline: RenesasPipeline-EmbeddedLinuxPipeline*
91-
92-
##
104+
---
93105

94106
## Useful NPM and CDK commands
95107

0 commit comments

Comments
 (0)