

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 使用 FreeRTOS 指南为主板创建入门指南
<a name="afq-gsg"></a>

要获得 FreeRTOS 资格，必须使用 FreeRTOS 指南为主板创建入门指南。本指南引导用户设置硬件和开发环境，以便为 FreeRTOS 设备开发应用程序，并在设备上构建、运行和刷写创建的演示应用程序。

本指南必须在面向公众的网站上提供给客户。指南的 URL 是在 AWS 合作伙伴设备目录中列出合格主板的必要条件。

该指南必须包含以下说明：
+ 设置设备硬件。
+ 设置开发环境。
+ 构建并运行演示项目。
+ 调试。
+ 故障排除。

我们还建议该指南中包括：
+ 指向 MCU 数据表的链接。
+ 印刷电路板 (PCB) 原理图。
+ 默认映像启动控制台日志。

**重要**  
如果说明因操作系统而异，则必须针对 Windows、Linux 和 macOS 操作系统提供说明。

为主板编写指南时遵照[入门指南模板](getting_started_template.md)。您可以在[《FreeRTOS 用户指南》](https://docs.aws.amazon.com/freertos/latest/userguide/freertos-getting-started.html)中找到其他获得资格的主板的已发布指南示例。[APN 合作伙伴中心](https://partnercentral.awspartner.com/)提供了入门指南的模板。

# 入门指南模板
<a name="getting_started_template"></a>

编写概述，提供对主板的简要说明。本部分应回答以下问题：
+ 运行演示应用程序需要什么硬件？

  提供指向公司网站页面的链接，以了解更多详细信息。
+ 开发主板应用程序时支持哪些？ IDEs 

  提供指向 IDE 用户指南和下载页面的链接。
+ 开发需要用到哪些工具链和其他软件实用程序？

  提供指向用户指南和下载页面的链接。
+ 对于有关主板的 FreeRTOS 入门，是否需要具备其他先决条件？

  提供指向购买页面、用户指南和下载页面的链接。

## 设置硬件
<a name="template-setup-hardware"></a>

本部分阐述如何设置平台的硬件。请确保提供指向用于设置硬件的任何用户指南或其他文档的链接。

这些说明包括以下内容：
+ 配置跳线设置。
+ 下载并安装驱动程序。

  提供指向支持的驱动程序版本的下载页面和其他文档的链接。
+ 将主板连接到计算机。
+ 设置硬件所需的其他任何步骤。

## 设置开发环境
<a name="template-setup-dev"></a>

本部分阐述如何设置平台支持的开发环境。请确保提供指向每一项的任何下载页面、用户指南或其他文档的链接。

这些说明包括以下内容：
+ 建立串行连接。
+ 下载并安装工具链。
+ 下载并安装支持的 IDE。
+ 为设备开发和调试应用程序所需的其他任何软件。

## 构建和运行演示应用程序
<a name="template-build-and-run-example"></a>

### 构建演示应用程序
<a name="template-freertos-import-project"></a>

本部分阐述如何在支持的 IDE 中构建提供的演示应用程序或使用支持的命令行工具进行构建的说明。

### 运行演示应用程序项目
<a name="template-run-examples"></a>

本部分阐述如何在主板上刷写和运行 FreeRTOS 演示代码。

## 调试
<a name="template-debugging"></a>

本部分阐述如何使用板载调试程序或外部调试程序。

## 问题排查
<a name="template-troubleshooting"></a>

本部分阐述用于解决常见问题或潜在问题的故障排除技巧。

**入门指南**模板可从此处的 [APN 合作伙伴门户网站](https://partnercentral.awspartner.com/ContentFolderPartner?id=0690h000009VVzsAAG)下载。需要凭证才能登录。