diff --git a/README.md b/README.md index 8d12c82f..06cf206a 100644 --- a/README.md +++ b/README.md @@ -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 - +
- - - + + + + - - - + + + + -
KIT_XMC14_2GOKIT_XMC11_BOOT_001KIT_XMC1400_ARDUINOKIT_XMC14_2GOKIT_XMC11_BOOT_001KIT_XMC1400_ARDUINOKIT_XMC13_BOOT_001
- - - - - + + + - - - + + +
KIT_XMC_PLT2GO_XMC4200KIT_XMC_PLT2GO_XMC4400KIT_XMC47_RELAX_5V_AD_V1KIT_XMC_PLT2GO_XMC4200KIT_XMC_PLT2GO_XMC4400KIT_XMC47_RELAX_5V_AD_V1
-### 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