Skip to content

Commit

Permalink
readme: add missing boards, re-formulate, add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
ederjc committed Sep 20, 2024
1 parent 8291738 commit 561b650
Showing 1 changed file with 26 additions and 24 deletions.
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,48 @@
# Infineon's XMC Microcontroller Boards for Arduino
# Arduino Core for Infineon's XMC™ Microcontrollers

This repository integrates [Infineon's](https://www.infineon.com/) XMC microcontrollers into the [Arduino IDE](https://www.arduino.cc/en/main/software).
![compile examples badge](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/compile-platform-examples.yml/badge.svg)
![build docs badge](https://github.com/Infineon/XMC-for-Arduino/actions/workflows/docs.yml/badge.svg)

The [XMC microcontroller family](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) from Infineon is a powerful and versatile platform for embedded system development. The XMC for Arduino library provides a comprehensive set of APIs, examples, and tools for developing a wide range of applications, allowing developers to leverage the ease of use and flexibility of the Arduino platform while harnessing the advanced features and performance of the XMC microcontrollers.
This project integrates Infineon's 32-bit XMC™ Industrial Arm® Cortex®-M Microcontroller into the [Arduino](https://www.arduino.cc/en/Guide/Introduction) ecosystem.

The [XMC™ microcontroller family](https://www.infineon.com/cms/de/product/microcontroller/32-bit-industrial-microcontroller-based-on-arm-cortex-m/) from Infineon is a powerful and versatile platform for embedded system development. The XMC for Arduino core provides a comprehensive set of APIs, examples, and tools for developing a wide range of applications, allowing developers to leverage the ease of use and flexibility of the Arduino platform while harnessing the advanced features and performance of the XMC™ microcontrollers.

## Supported Microcontroller Boards

<table>
<table style="text-align : center">
<tr>
<td><img src="docs/img/KIT_XMC14_2GO.png" width="300"></td>
<td><img src="docs/img/XMC1100_Boot-Kit.jpg" width="300"></td>
<td><img src="docs/img/XMC1400_Arduino_Kit.jpg" width="300"></td>
<td><img src="docs/img/KIT_XMC14_2GO.png" width="250"></td>
<td><img src="docs/img/KIT_XMC11_BOOT_001.jpg" width="250"></td>
<td><img src="docs/img/KIT_XMC1400_ARDUINO.jpg" width="250"></td>
<td><img src="docs/img/KIT_XMC13_BOOT_001.jpg" width="250"></td>
</tr>
<tr>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145">KIT_XMC14_2GO</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/">KIT_XMC11_BOOT_001</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/">KIT_XMC1400_ARDUINO</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc14_2go/?redirId=282145">KIT_XMC14_2GO</a></td>
<td><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc11_boot_001/">KIT_XMC11_BOOT_001</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc1400_arduino/">KIT_XMC1400_ARDUINO</a></td>
<td><a href="https://www.infineon.com/cms/de/product/evaluation-boards/kit_xmc13_boot_001/">KIT_XMC13_BOOT_001</a></td>
</tr>
</table>

<table>
<tr>
<td><img src="docs/img/XMC4200-Platform2go.jpg" width="300"></td>
<td><img src="docs/img/XMC4400-Platform2GO-Kit.jpg" width="300"></td>
<td><img src="docs/img/XMC4700_Relax_Kit_5VShields.jpg" width="300"></td>
<td><img src="docs/img/KIT_XMC_PLT2GO_XMC4200.jpg" width="250"></td>
<td><img src="docs/img/KIT_XMC_PLT2GO_XMC4400.jpg" width="250"></td>
<td><img src="docs/img/KIT_XMC47_RELAX_5V_AD_V1.jpg" width="250"></td>
</tr>
<tr>
<td style="test-align: center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/">KIT_XMC_PLT2GO_XMC4200</a></td>
<td style="test-align: center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/">KIT_XMC_PLT2GO_XMC4400</a></td>
<td style="test-align : center"><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289">KIT_XMC47_RELAX_5V_AD_V1</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4200/">KIT_XMC_PLT2GO_XMC4200</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_plt2go_xmc4400/">KIT_XMC_PLT2GO_XMC4400</a></td>
<td><a href="https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc47_relax_5v_ad_v1/?redirId=114289">KIT_XMC47_RELAX_5V_AD_V1</a></td>
</tr>
</table>

### Library Installation

In order to get started, please visit the instalation instructions [here](Link Docs Instalation Instructions).
More information about supported boards can be found [here](https://xmc-arduino.readthedocs.io/en/latest/hw-platforms.html).

## Getting Started

## Additional Information
For installation & getting started instructions please refer to [our docs](https://xmc-arduino.readthedocs.io/en/latest/index.html).

More information can be found within the library [docs] (Link Docs).
## Contributing

We welcome community contributions! Please refer to our [contribution guidelines](CONTRIBUTING.md). Your help is greatly appreciated 👐

## License

Expand Down

0 comments on commit 561b650

Please sign in to comment.