Skip to content

Commit b941a8e

Browse files
authored
Update README.md
1 parent 7a988cc commit b941a8e

File tree

1 file changed

+14
-52
lines changed

1 file changed

+14
-52
lines changed

README.md

Lines changed: 14 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,34 @@
1-
# WICED-SDK-with-PSoC-6-Support-Examples using ModusToolbox<sup>TM</sup> IDE
2-
This repository is a "Table of Contents" for the many ModusToolbox IDE code examples that are coming, and for resources available to you as a ModusToolbox developer. As code examples appear, this document will link to them. Until then, use this to locate PSoC 6 MCU and SDK resources.
1+
# MCUExamples for PSoC 6 SDK and ModusToolbox<sup>TM</sup> IDE
2+
33

44
# Table of Contents
55

6-
* [Importing a Code Example](#importing-a-code-example)
7-
* [Code Examples](#code-examples)
8-
* [Getting Started Examples](#getting-started-examples): basic examples that introduce the platform
9-
* [Analog Examples](#analog-examples): focus on analog peripherals like ADC, DAC, and comparators
10-
* [Digital Examples](#digital-examples): focus on a non-analog peripheral, such as UART, I2C, RTC, DMA, Interrupts, and so forth
11-
* [BLE Examples](#ble-examples): demonstrate Bluetooth Low Energy connectivity
12-
* [RTOS Examples](#rtos-examples): demonstrate how to integrate an RTOS
13-
* [System Examples](#system-examples): more complex examples that demonstrate a solution, such as a bootloader
6+
* [Overview](#overview)
7+
* [Creating the Code Example](#creating-the-code-example)
8+
* [MCU Code Examples](#mcu-code-examples)
149
* [ModusToolbox IDE](#modustoolbox-ide)
1510
* [Kits](#kits)
1611
* [Technical Resources](#technical-resources)
1712

18-
# Importing a Code Example
19-
20-
We assume you're familiar with GitHub. You may need a little help understanding how to get the example into the IDE.
21-
22-
When you go to the repository, you can download or clone the repository. The IDE import process starts the same either way.
23-
24-
Use **File** > **Import** > **General** > **Existing projects into workspace**.
25-
26-
*If you downloaded a zip*: enable the **Select Archive File** option and browse to locate the archive (zip file)
27-
28-
*If you cloned*: enable the **Select root directory** option and browse to locate the directory where you cloned the example.
29-
30-
Then import all the projects in the archive or root directory. Most code examples have a PDF document that explains the code example. You will find that PDF file in the code example folder. Or you can read it right here on GitHub.
31-
32-
# Code Examples
13+
## Overview
3314

34-
Cypress provides a rich set of code examples for the PSoC 6 MCU, using the ModusToolbox IDE. PSoC 6 MCU bridges the gap between expensive, power hungry application processors and low‑performance microcontrollers (MCUs). The ultra‑low‑power, dual-core architecture of PSoC 6 MCU offers the processing performance needed by IoT devices, eliminating the tradeoffs between power and performance.
15+
These examples demonstrate the peripherals and basic functionality of the PSoC 6 MCU. Each example has a readme.txt, and a comprehensive PDF document that explains what to do and what to observe when running the example.
3516

36-
Code examples are grouped by category. The same code example may appear in more than one category. All the code examples come with well documented design guidelines to help you understand the design and how to develop it. Feel free to explore the code example source files and let's innovate together!
17+
## Creating the Code Example
3718

38-
This ReadMe also includes information about ModusToolbox software, links to avaliable kits, and programming resources for PSoC 6 MCU.
19+
Download the example and unzip the repository onto your local machine. You can also clone the repository into a location on your local machine.
3920

40-
## Getting Started Examples
21+
In the ModusToolbox IDE, use **File > New > ModusToolbox IDE Application**. Pick your kit or device. You must use a supported kit or device as noted in the Requirements section above.
4122

42-
| Code Example | Supported Kits | Notes |
43-
| ----- | ----- | ----- |
44-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
45-
46-
## Analog Examples
47-
| Code Example | Supported Kits | Notes |
48-
| ----- | ----- | -----
49-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
23+
In the **Starter Application** window, click the **Browse** button and navigate to the _modus.mk_ file for the example. Click **Next** and complete the application creation process.
24+
Then import all the projects in the archive or root directory.
5025

51-
## Digital Examples
26+
# MCU Code Examples
5227
| Code Example | Supported Kits | Notes |
5328
| ----- | ----- | ----- |
54-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
29+
| Come back soon | TBD | Notes here |
5530

56-
## BLE Examples
57-
| Code Example | Supported Kits | Notes |
58-
| ----- | ----- | -----
59-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
60-
61-
## RTOS Examples
62-
| Code Example | Supported Kits | Notes |
63-
| ----- | ----- | -----
64-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
6531

66-
## System Examples
67-
| Code Example | Supported Kits | Notes |
68-
| ----- | ----- | -----
69-
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
7032

7133
# ModusToolbox IDE
7234
![](/images/MTbanner.png)

0 commit comments

Comments
 (0)