From 54f3c8e72beb677ac3015985739e982c23e771ff Mon Sep 17 00:00:00 2001 From: Carlos Alatorre Date: Mon, 8 Apr 2024 13:42:57 -0600 Subject: [PATCH] feat(docs):Update README.md Add CLA and minimal tweaks Signed-off-by: Carlos Alatorre --- README.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6756d46..a4096c8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # MPU6050 by Electronic Cats - Library for Arduino - - - - - -

- - - +

+ + + +

+

+ + +

[![LibraryBuild](https://github.com/ElectronicCats/mpu6050/actions/workflows/LibraryBuild.yml/badge.svg)](https://github.com/ElectronicCats/mpu6050/actions/workflows/LibraryBuild.yml) @@ -15,10 +15,11 @@ Arduino library for controlling MPU6050 module. MPU6050 Combines a 3-axis gyroscope and a 3-axis accelerometer on the same silicon die together with -an onboard Digital Motion Processor(DMP) which processes complex 6-axis MotionFusion algorithms. +an onboard DMP (_Digital Motion Processor_) which processes complex 6-axis MotionFusion algorithms. -## Features of this version +_Based on [jrowberg/i2cdevlib](https://github.com/jrowberg/i2cdevlib/tree/master/Arduino/MPU6050)_ +## Features of this version - ### Supported Chipsets - AVR - SAM @@ -28,18 +29,21 @@ an onboard Digital Motion Processor(DMP) which processes complex 6-axis MotionFu - ESP8266 - RENESAS +## Quick Installing +To install, use the [Arduino Library Manager](https://support.arduino.cc/hc/en-us/articles/5145457742236-Add-libraries-to-Arduino-IDE) and search for "MPU6050" and install the MPU6050 by Electronic Cats library. -#### Original Library +## How to contribute + Contributions are welcome! -Based in the work of [jrowberg/i2cdevlib](https://github.com/jrowberg/i2cdevlib/tree/master/Arduino/MPU6050) +Please read the document [**Contribution Manual**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-contribution-manual.md) which will show you how to contribute your changes to the project. -## Quick Installing +✨ Thanks to all our [contributors](https://github.com/ElectronicCats/mpu6050/graphs/contributors)! ✨ -To install, use the [Arduino Library Manager](https://support.arduino.cc/hc/en-us/articles/5145457742236-Add-libraries-to-Arduino-IDE) and search for "MPU6050" and install the MPU6050 by Electronic Cats library. +See [**_Electronic Cats CLA_**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-cla.md) for more information. +See the [**community code of conduct**](https://github.com/ElectronicCats/electroniccats-cla/blob/main/electroniccats-community-code-of-conduct.md) for a vision of the community we want to build and what we expect from it. ## Maintainer -