Skip to content

Commit

Permalink
[DOCS] Updated to restructure readme under demo application folder. M…
Browse files Browse the repository at this point in the history
…32MM-451
  • Loading branch information
SyedThaseemuddin committed Jun 25, 2020
1 parent 5ebeecb commit 9e46556
Show file tree
Hide file tree
Showing 587 changed files with 253 additions and 249 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@
**/*.IAR/settings
**/*.IAR/*.dep
**/*.IAR/*.custom_argvars
/docs/apps/sam_d21_cnano/ble_weather_station/hex
/docs/apps/sam_d21_cnano/fitness_tracker/hex
/docs/apps/sam_d21_cnano/location_sos/hex
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ exclude:
- "*.bmp"
- "*.txt"
- "*.yml"
- "*.bin"

# Aux links for the upper right navigation
aux_links:
Expand Down
2 changes: 1 addition & 1 deletion apps/pic32mk_gp_db/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 10

This folder contains the MPLAB® Harmony 3 reference applications developed on [PIC32MK General Purpose (GP) Development Board](https://www.microchip.com/DevelopmentTools/ProductDetails/DM320106).

* [Getting Started](./pic32mk_getting_started/docs/readme.md)
* [Getting Started](./pic32mk_getting_started/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
2 changes: 1 addition & 1 deletion apps/pic32mx470_curiosity/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 11

This folder contains the MPLAB® Harmony 3 reference applications developed on [Curiosity PIC32MX470 Development Board](https://www.microchip.com/DevelopmentTools/ProductDetails/DM320103).

* [Getting Started](./pic32mx470_getting_started/docs/readme.md)
* [Getting Started](./pic32mx470_getting_started/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ nav_order: 2
## Software/Tools Used:
<span style="color:blue"> *This project has been verified to work with the following versions of software tools:*</span>

- [MPLAB Harmony v3 "csp" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/csp/releases/tag/v3.5.2)
- [MPLAB Harmony v3 "dev_packs" repo v3.7.0](https://github.com/Microchip-MPLAB-Harmony/dev_packs/releases/tag/v3.5.0)
- [MPLAB Harmony v3 "mhc" repo v3.4.0](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.3.3)
- [MPLAB Harmony v3 "csp" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/csp/releases/tag/v3.7.1)
- [MPLAB Harmony v3 "dev_packs" repo v3.7.0](https://github.com/Microchip-MPLAB-Harmony/dev_packs/releases/tag/v3.7.0)
- [MPLAB Harmony v3 "mhc" repo v3.4.0](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.4.0)
- MPLAB Harmony Configurator Plugin v3.5.0
- [MPLAB X IDE v5.40](https://www.microchip.com/mplab/mplab-x-ide)
- [MPLAB XC32 Compiler v2.41](https://www.microchip.com/mplab/compilers)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ nav_order: 4
- [MPLAB Harmony v3 "csp" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/csp/releases/tag/v3.7.1)
- [MPLAB Harmony v3 "core" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/core/releases/tag/v3.7.1)
- [MPLAB Harmony v3 "dev_packs" repo v3.7.0](https://github.com/Microchip-MPLAB-Harmony/dev_packs/releases/tag/v3.7.0)
- [MPLAB Harmony v3 "mhc" repo v3.4.0](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.3.3)
- [MPLAB Harmony v3 "mhc" repo v3.4.0](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.4.0)
- [MPLAB Harmony v3 "bsp" repository v3.7.0](https://github.com/Microchip-MPLAB-Harmony/bsp/releases/tag/v3.7.0)
- [MPLAB Harmony v3 "usb" repository v3.5.0](https://github.com/Microchip-MPLAB-Harmony/usb/releases/tag/v3.5.0)
- MPLAB Harmony Configurator Plugin v3.5.0
Expand Down
10 changes: 5 additions & 5 deletions apps/pic32mz_ef_curiosity_v2/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ nav_order: 2
This folder contains the MPLAB® Harmony 3 reference applications developed on [Curiosity PIC32MZ EF 2.0 Development Board](https://www.microchip.com/Developmenttools/ProductDetails/DM320209).


* [Getting Started](./pic32mzef_getting_started/docs/readme.md)
* [Getting Started Extended](./getting_started_ext/docs/readme.md)
* [Getting Started Middleware - EEPROM/Thumb drive temperature logger](./getting_started_middleware/docs/readme.md)
* [USB MSD with Multiple Drives](./msd_multiple_luns/docs/readme.md)
* [SD Card Audio Player](./sdcard_player/docs/readme.md)
* [Getting Started](./pic32mzef_getting_started/readme.md)
* [Getting Started Extended](./getting_started_ext/readme.md)
* [Getting Started Middleware - EEPROM/Thumb drive temperature logger](./getting_started_middleware/readme.md)
* [USB MSD with Multiple Drives](./msd_multiple_luns/readme.md)
* [SD Card Audio Player](./sdcard_player/readme.md)


### **Note:**
Expand Down
2 changes: 1 addition & 1 deletion apps/pic32mz_ef_sk/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 13
This folder contains the MPLAB® Harmony 3 reference applications developed on [PIC32MZ Embedded Connectivity with FPU (EF) Starter Kit](https://www.microchip.com/Developmenttools/ProductDetails/DM320007).


* [Live Update](./pic32mz_uart_live_update/docs/readme.md)
* [Live Update](./pic32mz_uart_live_update/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
12 changes: 6 additions & 6 deletions apps/pic32mz_ef_sk_meb2/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ nav_order: 12

This folder contains the MPLAB® Harmony 3 reference applications developed on [PIC32MZ Embedded Connectivity with FPU (EF) Starter Kit](https://www.microchip.com/Developmenttools/ProductDetails/DM320007) + [MEB-II](https://www.microchip.com/DevelopmentTools/ProductDetails/DM320005-5).

* [SD Card Player/Reader series](./audio_player/docs/readme.md)
* [Audio-Tone using a Lookup Table](./audio_player/audio_player_lab1/docs/readme.md)
* [Audio-Tone Application by reading the tone from a text file stored in an SD card](./audio_player/audio_player_lab2/docs/readme.md)
* [SD Card Reader and Audio-Tone Application by reading the tone from a text file stored in an SD card](./audio_player/audio_player_lab3/docs/readme.md)
* [SD Card Reader ".wav" Audio player](./audio_player/audio_player_lab4/docs/readme.md)
* [SD Card Audio Player/Reader with Aria Graphics](./audio_player/audio_player_lab5/docs/readme.md)
* [SD Card Player/Reader series](./audio_player/readme.md)
* [Audio-Tone using a Lookup Table](./audio_player/audio_player_lab1/readme.md)
* [Audio-Tone Application by reading the tone from a text file stored in an SD card](./audio_player/audio_player_lab2/readme.md)
* [SD Card Reader and Audio-Tone Application by reading the tone from a text file stored in an SD card](./audio_player/audio_player_lab3/readme.md)
* [SD Card Reader ".wav" Audio player](./audio_player/audio_player_lab4/readme.md)
* [SD Card Audio Player/Reader with Aria Graphics](./audio_player/audio_player_lab5/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
2 changes: 1 addition & 1 deletion apps/sam_c21_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ nav_order: 5

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM C21 Xplained Pro evaluation kit](https://www.microchip.com/developmenttools/ProductDetails/atsamc21-xpro).

* [Low Power](./samc21_low_power/docs/readme.md)
* [Low Power](./samc21_low_power/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
2 changes: 1 addition & 1 deletion apps/sam_c21n_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 9

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM C21N Xplained Pro Evaluation Kit](https://www.microchip.com/developmenttools/ProductDetails/atsamc21n-xpro).

* [Getting Started](./samc21n_getting_started/docs/readme.md)
* [Getting Started](./samc21n_getting_started/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ nav_order: 3
<span style="color:blue"> *This project has been verified to work with the following versions of software tools:*</span>

- [MPLAB Harmony v3 "csp" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/csp/releases/tag/v3.7.1)
- [MPLAB Harmony v3 "core" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/core/releases/tag/v3.5.2)
- [MPLAB Harmony v3 "core" repo v3.7.1](https://github.com/Microchip-MPLAB-Harmony/core/releases/tag/v3.7.1)
- [MPLAB Harmony v3 "dev_packs" repo v3.5.0](https://github.com/Microchip-MPLAB-Harmony/dev_packs/releases/tag/v3.5.0)
- [MPLAB Harmony v3 "mhc" repo v3.3.3](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.3.3)
- MPLAB Harmony Configurator Plugin v3.4.0
- [MPLAB Harmony v3 "mhc" repo v3.4.0](https://github.com/Microchip-MPLAB-Harmony/mhc/releases/tag/v3.4.0)
- MPLAB Harmony Configurator Plugin v3.5.0
- [MPLAB X IDE v5.30](https://www.microchip.com/mplab/mplab-x-ide)
- [MPLAB XC32 Compiler v2.30](https://www.microchip.com/mplab/compilers)

Expand Down
8 changes: 4 additions & 4 deletions apps/sam_d21_cnano/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ nav_order: 1

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM D21 Curiosity Nano Evaluation Kit](https://www.microchip.com/Developmenttools/ProductDetails/DM320119).

* [Getting Started](./samd21n_getting_started/docs/readme.md)
* [Fitness Tracker](./fitness_tracker/docs/readme.md)
* [Location Tagged SOS](./location_sos/docs/readme.md)
* [BLE Weather Station and Motion Sensor](./ble_weather_station/docs/readme.md)
* [Getting Started](./samd21n_getting_started/readme.md)
* [Fitness Tracker](./fitness_tracker/readme.md)
* [Location Tagged SOS](./location_sos/readme.md)
* [BLE Weather Station and Motion Sensor](./ble_weather_station/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
2 changes: 1 addition & 1 deletion apps/sam_d21_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 8

This repository contains the MPLAB® Harmony 3 reference applications developed on [SAM D21 Xplained Pro Evaluation Kit](https://www.microchip.com/developmenttools/ProductDetails/atsamd21-xpro).

* [Getting Started](./samd21_getting_started/docs/readme.md)
* [Getting Started](./samd21_getting_started/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
4 changes: 2 additions & 2 deletions apps/sam_e54_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ nav_order: 7

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM E54 Xplained Pro Evaluation Kit](https://www.microchip.com/DevelopmentTools/ProductDetails/ATSAME54-XPRO).

* [Getting Started](./same54_getting_started/docs/readme.md)
* [SleepWalking](./sleepwalking/docs/readme.md)
* [Getting Started](./same54_getting_started/readme.md)
* [SleepWalking](./sleepwalking/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions apps/sam_e70_xult/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ nav_order: 6

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM E70 Xplained Ultra Evaluation Kit](https://www.microchip.com/Developmenttools/ProductDetails/DM320113).

* [Getting Started](./same70_getting_started/docs/readme.md)
* [Getting Started with Drivers](./getting_started_drv/docs/readme.md)
* [Getting Started with FreeRTOS](./getting_started_freertos/docs/readme.md)
* [XDMAC with QSPI](./qspi_xdmac_read_write/docs/readme.md)
* [Ethernet bootloader - File Transfer Protocol](./ftp_bootloader/docs/readme.md)
* [Getting Started](./same70_getting_started/readme.md)
* [Getting Started with Drivers](./getting_started_drv/readme.md)
* [Getting Started with FreeRTOS](./getting_started_freertos/readme.md)
* [XDMAC with QSPI](./qspi_xdmac_read_write/readme.md)
* [Ethernet bootloader - File Transfer Protocol](./ftp_bootloader/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down
4 changes: 2 additions & 2 deletions apps/sam_l10_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ nav_order: 3

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM L10 Xplained Pro Evaluation Kit](https://www.microchip.com/Developmenttools/ProductDetails/DM320204).

* [Getting Started](./saml10_getting_started/docs/readme.md)
* [Low Power](./saml10_low_power/docs/readme.md)
* [Getting Started](./saml10_getting_started/readme.md)
* [Low Power](./saml10_low_power/readme.md)


### **Note:**
Expand Down
2 changes: 1 addition & 1 deletion apps/sam_l21_xpro/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ nav_order: 4

This folder contains the MPLAB® Harmony 3 reference applications developed on [SAM L21 Xplained Pro Evaluation Kit](https://www.microchip.com/developmenttools/ProductDetails/atsaml21-xpro-b).

* [Low Power](./saml21_low_power/docs/readme.md)
* [Low Power](./saml21_low_power/readme.md)

### **Note:**
The applications in this repository are an alternative source of reference involving integration of multiple technologies, extending hardware capabilities and demonstrating specific MCU features.
Expand Down

This file was deleted.

Large diffs are not rendered by default.

Loading

0 comments on commit 9e46556

Please sign in to comment.