Skip to content

Commit 5046d4c

Browse files
authored
Clean-up README as per default Arduino library README requirements. (#18)
1 parent 03ab283 commit 5046d4c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" />
2+
13
`Arduino_AdvancedAnalog`
24
===========================
35
[![Compile Examples status](https://github.com/bcmi-labs/AdvancedAnalogRedux/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/bcmi-labs/AdvancedAnalogRedux/actions/workflows/compile-examples.yml)
@@ -7,5 +9,31 @@
79

810
Advanced Analog Library for Arduino Giga.
911

12+
## :mag_right: Resources
13+
14+
* [How to install a library](https://www.arduino.cc/en/guide/libraries)
15+
* [Help Center](https://support.arduino.cc/)
16+
* [Forum](https://forum.arduino.cc)
17+
18+
## :bug: Bugs & Issues
19+
20+
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.
21+
22+
## :technologist: Development
23+
24+
There are many ways to contribute:
25+
26+
* Improve documentation and examples
27+
* Fix a bug
28+
* Test open Pull Requests
29+
* Implement a new feature
30+
* Discuss potential ways to improve this library
31+
32+
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.
33+
34+
## :yellow_heart: Donations
35+
36+
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.
37+
1038
## Known issues
1139
* ADC is running at the slowest possible clock (PCLK), should probably set up a PLL and change the clock source.

0 commit comments

Comments
 (0)