Skip to content

Devops/add link checker badge #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 4, 2025
Merged

Devops/add link checker badge #147

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2b1648c
.github/workflows: Add link checker.
ederjc Jul 29, 2025
887f03b
README.md: Add link checker badge.
ederjc Jul 30, 2025
87f75c6
README.md: Move badges down.
ederjc Jul 30, 2025
f301d7b
README.md: Simplify content, remove HTML.
ederjc Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/check_links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Check links

on:
workflow_dispatch:
push:
branches:
- master
- main
tags:
- '*'
pull_request:
schedule:
- cron: '30 3 * * 4' # Run every Thursday at 3:30 AM UTC

jobs:
linkChecker:
uses: Infineon/makers-devops/.github/workflows/check_links.yml@main
63 changes: 18 additions & 45 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a id="readme-top"></a>
# Arduino Core for Infineon's PSOC™ 6 Microcontrollers

<!-- PROJECT SHIELDS -->
[![compile examples](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/compile_examples.yml/badge.svg)](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/compile_examples.yml)
Expand All @@ -7,40 +7,23 @@
[![code spell check](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/codespell.yml/badge.svg)](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/codespell.yml)
[![commit message check](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/commit_formatting.yml/badge.svg)](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/commit_formatting.yml)
[![docs build](https://readthedocs.org/projects/arduino-core-psoc6/badge/?version=latest)](https://arduino-core-psoc6.readthedocs.io/en/latest/?badge=latest)
[![check links](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/check_links.yml/badge.svg)](https://github.com/Infineon/arduino-core-psoc6/actions/workflows/check_links.yml)

<!-- PROJECT LOGO -->
<br />
<h2 align="center">Arduino Core for Infineon's PSOC™ 6 Microcontrollers</h2>
This repository integrates Infineon's [PSOC™ 6 microcontrollers](https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-6-32-bit-arm-cortex-m4-mcu/) into the [Arduino ecosystem](https://www.arduino.cc/en/main/software).

<p align="center">
This repository integrates Infineon's <a href="https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-6-32-bit-arm-cortex-m4-mcu/">PSOC™ 6 microcontrollers</a> into the <a href="https://www.arduino.cc/en/main/software">Arduino ecosystem</a>.
<br />
<br />
<a href="https://arduino-core-psoc6.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/Infineon/arduino-core-psoc6/issues/new?labels=bug&template=bug_report.md">Report Bug</a>
·
<a href="https://github.com/Infineon/arduino-core-psoc6/issues/new?labels=enhancement&template=feature_request.md">Request Feature</a>
<br />
</p>
</div>


> [!WARNING]
> This project is work in progress. Currently not all PSOC™ 6 products & features are supported in Arduino. Please refer to the docs for further information.
## Getting Started

[**Explore the docs**](https://arduino-core-psoc6.readthedocs.io/en/latest/)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have removed the WIP warning here. Was this intentional? Should we also remove it from the read the docs?

· [Report Bug](https://github.com/Infineon/arduino-core-psoc6/issues/new?labels=bug&template=bug_report.md)
· [Request Feature](https://github.com/Infineon/arduino-core-psoc6/issues/new?labels=enhancement&template=feature_request.md)

<!-- ABOUT THE PROJECT -->
## About The Project

The Arduino Core for Infineon's PSOC™ 6 microcontrollers aims to bring the advanced features and versatility of Infineon's PSOC™ 6 family into the Arduino ecosystem. By integrating these powerful microcontrollers, developers can leverage the extensive libraries, tools, and community support of Arduino to build innovative and high-performance projects.

### Features

Please refer to [supported features](https://arduino-core-psoc6.readthedocs.io/en/latest/supported-features.html)

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Please refer to [supported features](https://arduino-core-psoc6.readthedocs.io/en/latest/supported-features.html) in our docs.

## Supported Products

Expand All @@ -53,45 +36,35 @@ Please refer to [supported features](https://arduino-core-psoc6.readthedocs.io/e
</tr>
</table>

## Getting Started

For installation & getting started instruction please refer to [our docs](https://arduino-core-psoc6.readthedocs.io/en/latest/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Additional Information

Please visit our [PSOC™ 6 products page](https://www.infineon.com/cms/en/product/microcontroller/32-bit-psoc-arm-cortex-microcontroller/psoc-6-32-bit-arm-cortex-m4-mcu/) for datasheets, pin out diagrams, and additional technical information.
Please visit our [PSOC™ 6 products page](https://www.infineon.com/products/microcontroller/32-bit-psoc-arm-cortex/psoc-6-m4-mcu) for datasheets, pin out diagrams, and additional technical information.

## Contributing

We welcome community contributions! Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated** 👐.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
If you have a suggestion that would make this better, please fork the repo and create a [pull request](https://github.com/Infineon/arduino-core-psoc6/pulls). You can also simply open a feature request [issue](https://github.com/Infineon/arduino-core-psoc6/issues).

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'folder/sub-folder: Add some AmazingFeature.' -s`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
1. [Fork](https://github.com/Infineon/arduino-core-psoc6/fork) the project
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -sm 'folder/sub-folder: Add some amazing-feature.'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a [pull request](https://github.com/Infineon/arduino-core-psoc6/pulls)

Before submitting a pull request, please check the [Code of Conduct](https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_OF_CONDUCT.md) and [Code Conventions](https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_CONVENTIONS.md) for the PSOC™ 6 for Arduino project. Thank you for following these guidelines.
Before submitting a pull request, please check the [code of conduct](https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_OF_CONDUCT.md) and [code conventions](https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_CONVENTIONS.md) for the PSOC™ 6 for Arduino project. Thank you for following these guidelines.

Don't forget to give the project a star :star:! Thanks again!

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Important Note

Significant contributions should be aligned with the project team in advance.

### Top Contributors:
### Top Contributors

<a href="https://github.com/Infineon/arduino-core-psoc6/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Infineon/arduino-core-psoc6&max=50&columns=50" />
</a>

## License
Refer to the [license](LICENSE.md) file for more details about this project's license.

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Refer to the [license](LICENSE.md) file for more details about this project's license.
Loading