Skip to content

README templates

Jump to bottom
Brian Murray edited this page Feb 17, 2022 · 16 revisions

The READMEs for this repo are required to use a specific format.

  1. Service level folder README template

Customers in an AWS Service or SDK guide are directed to this README if they choose the link to GitHub from a single action or scenario code example - for example from Create an Amazon SNS topic using an AWS SDK. The README is designed to enable customers to scan the contents and grasp the context, and understand how to find and run examples.

  1. Language level folder README

Customers in an AWS Service guide are directed to this README if they choose the link to GitHub from the top-level SDK information topic for example from Using Amazon SNS with an AWS SDK. The README is designed to enable customers with introductory information about the code examples for that language.

  1. Cross service level folder README

This is a README list all the individual cross service example for a given AWS SDK language.

  1. Single cross-service example README

Customers in an AWS Service or SDK guide are directed to this README if they choose the link to GitHub from a cross-service code example - for example from Build a publish and subscription application that translates messages. The README is designed to enable customers to understand how to find and run examples.

Clone this wiki locally