Skip to content

Commit c237877

Browse files
authored
Merge pull request #9 from arduino-libraries/cleanup-readme
Fix: README to conform to standard Arduino README layout/content.
2 parents 059560c + c6a49cf commit c237877

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.idea/

README.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
# Arduino_PF1550
1+
<img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" />
22

3+
`Arduino_PF1550`
4+
================
35
[![Check Arduino status](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/check-arduino.yml)
46
[![Compile Examples status](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/compile-examples.yml)
57
[![Spell Check status](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_PF1550/actions/workflows/spell-check.yml)
@@ -10,3 +12,30 @@ Library to handle the PMIC (Power Management IC) on the following Arduino boards
1012
- [Arduino Portenta H7 Lite](https://docs.arduino.cc/hardware/portenta-h7-lite)
1113
- [Arduino Portenta H7 Lite Connected](https://docs.arduino.cc/hardware/portenta-h7-lite-connected)
1214
- [Arduino Nicla Vision](https://docs.arduino.cc/hardware/nicla-vision)
15+
- [Arduino Portenta C33](https://docs.arduino.cc/hardware/portenta-c33)
16+
17+
## :mag_right: Resources
18+
19+
* [How to install a library](https://www.arduino.cc/en/guide/libraries)
20+
* [Help Center](https://support.arduino.cc/)
21+
* [Forum](https://forum.arduino.cc)
22+
23+
## :bug: Bugs & Issues
24+
25+
If you want to report an issue with this library, you can submit it to the [issue tracker](https://github.com/arduino-libraries/Arduino_Braccio_plusplus/issues) of this repository. Remember to include as much detail as you can about your hardware set-up, code and steps for reproducing the issue. Make sure you're using an original Arduino board.
26+
27+
## :technologist: Development
28+
29+
There are many ways to contribute:
30+
31+
* Improve documentation and examples
32+
* Fix a bug
33+
* Test open Pull Requests
34+
* Implement a new feature
35+
* Discuss potential ways to improve this library
36+
37+
You can submit your patches directly to this repository as Pull Requests. Please provide a detailed description of the problem you're trying to solve and make sure you test on real hardware.
38+
39+
## :yellow_heart: Donations
40+
41+
This open-source code is maintained by Arduino with the help of the community. We invest a considerable amount of time in testing code, optimizing it and introducing new features. Please consider [donating](https://www.arduino.cc/en/donate/) or [sponsoring](https://github.com/sponsors/arduino) to support our work, as well as [buying original Arduino boards](https://store.arduino.cc/) which is the best way to make sure our effort can continue in the long term.

0 commit comments

Comments
 (0)