Add contribution notes

rahul-thakoor · May 6, 2021 · 871e82d · 871e82d
1 parent 70e78e0
commit 871e82d
Showing 1 changed file with 62 additions and 60 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,82 +2,84 @@
 
 ## 0.2.1
 
-* Support for Raspberry Pi 4
+- Change license to MIT OR Apache-2.0 and add support for Raspberry Pi 4
 
-  - upgraded [rppal](https://github.com/golemparts/rppal/) to `0.12.0`. See [Issue #12](https://github.com/rahul-thakoor/rust_gpiozero/issues/23)
+  - Fix clippy and fmt warnings. Thanks @AldaronLau
+
+  - change license to either of MIT OR Apache-2.0. Thanks @owenbrooks
+
+  - upgraded [rppal](https://github.com/golemparts/rppal/) to `0.12.0`. See [Issue #22](https://github.com/rahul-thakoor/rust_gpiozero/issues/22) and [Issue #23](https://github.com/rahul-thakoor/rust_gpiozero/issues/23). Thanks @dmalenic
 
 ## 0.2.0
+
 `rust_gpiozero` now uses [rppal](https://github.com/golemparts/rppal/) for gpio access
 
-* **input_devices**
+- **input_devices**
+
   - **InputDevice** changes:
-    + `pin` is now `u8`
-    + `new` configures device with the pin pulled to low by default 
-    + Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
-    + `value` returns a `bool`
+
+    - `pin` is now `u8`
+    - `new` configures device with the pin pulled to low by default
+    - Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
+    - `value` returns a `bool`
 
   - **DigitalInputDevice** changes:
-    + `pin` is now `u8`
-    + `new` configures device with the pin pulled to low by default 
-    + Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
-    + `value` returns a `bool`
-    + `wait_for_inactive` takes an argument `timeout` (Option<f32>)
-    + `wait_for_active` takes an argument `timeout` (Option<f32>)
-
+    - `pin` is now `u8`
+    - `new` configures device with the pin pulled to low by default
+    - Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
+    - `value` returns a `bool`
+    - `wait_for_inactive` takes an argument `timeout` (Option<f32>)
+    - `wait_for_active` takes an argument `timeout` (Option<f32>)
   - **Button** changes:
-    + `pin` is now `u8`
-    + `new` configures device with the pin pulled to `high` by default 
-    + Added `new_with_pulldown`: create InputDevice with the pin number given with the pin pulled low with an internal resistor by default
-    + `value` returns a `bool`
-    + `wait_for_inactive` takes an argument `timeout` (Option<f32>)
-    + `wait_for_active` takes an argument `timeout` (Option<f32>)
-
-* **output_devices**
+    - `pin` is now `u8`
+    - `new` configures device with the pin pulled to `high` by default
+    - Added `new_with_pulldown`: create InputDevice with the pin number given with the pin pulled low with an internal resistor by default
+    - `value` returns a `bool`
+    - `wait_for_inactive` takes an argument `timeout` (Option<f32>)
+    - `wait_for_active` takes an argument `timeout` (Option<f32>)
+
+- **output_devices**
+
   - **PWMOutputDevice** (New)
-    + A generic output device configured for software pulse-width modulation (PWM)
-    + Values can be specified between 0.0 and 1.0 for varying levels of power in the device.
-
+    - A generic output device configured for software pulse-width modulation (PWM)
+    - Values can be specified between 0.0 and 1.0 for varying levels of power in the device.
   - **PWMLED** (New)
-    + Represents a light emitting diode (LED) with variable brightness.
-    + Values can be specified between 0.0 and 1.0 for varying levels of brightness.
-
+
+    - Represents a light emitting diode (LED) with variable brightness.
+    - Values can be specified between 0.0 and 1.0 for varying levels of brightness.
+
   - **Servo** (New)
-    + Represents a PWM-controlled servo motor connected to a GPIO pin
-
+    - Represents a PWM-controlled servo motor connected to a GPIO pin
   - **OutputDevice** changes:
-    + `pin` is now `u8`
-    + Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
-    + Added `set_active_high` to set the state for `active_high`
-
+    - `pin` is now `u8`
+    - Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
+    - Added `set_active_high` to set the state for `active_high`
   - **DigitalOutputDevice** changes:
-    + `pin` is now `u8`
-    + Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
-    + Added `set_active_high` to set the state for `active_high`
-    + Added `blink` to make the device turn on and off repeatedly in the background. 
-    + Added `set_blink_count`to set the number of times to blink the device
-    + Added `wait` which blocks until background blinking process is done
-
+    - `pin` is now `u8`
+    - Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
+    - Added `set_active_high` to set the state for `active_high`
+    - Added `blink` to make the device turn on and off repeatedly in the background.
+    - Added `set_blink_count`to set the number of times to blink the device
+    - Added `wait` which blocks until background blinking process is done
   - **LED** changes:
-    + `pin` is now `u8`
-    + Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
-    + Added `set_active_high` to set the state for `active_high`
-    + `blink` now takes `f32` for `on_time` and `off_time`. 
-    + Added `set_blink_count`to set the number of times to blink the device
-    + Added `wait` which blocks until background blinking process is done
-    + Added `is_lit` which returns True if the device is currently active and False otherwise.
-
+    - `pin` is now `u8`
+    - Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
+    - Added `set_active_high` to set the state for `active_high`
+    - `blink` now takes `f32` for `on_time` and `off_time`.
+    - Added `set_blink_count`to set the number of times to blink the device
+    - Added `wait` which blocks until background blinking process is done
+    - Added `is_lit` which returns True if the device is currently active and False otherwise.
   - **Buzzer** changes:
-    + `pin` is now `u8`
-    + Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
-    + Added `set_active_high` to set the state for `active_high`
-    + Added `beep` to make the device turn on and off repeatedly in the background. 
-    + Added `set_beep_count`to set the number of times to beep the device
-    + Added `wait` which blocks until background beeping process is done
-    + Removed `blink` method
-
+    - `pin` is now `u8`
+    - Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
+    - Added `set_active_high` to set the state for `active_high`
+    - Added `beep` to make the device turn on and off repeatedly in the background.
+    - Added `set_beep_count`to set the number of times to beep the device
+    - Added `wait` which blocks until background beeping process is done
+    - Removed `blink` method
   - **Motor** changes:
-    + `forward_pin` and `backward_pin`are now `u8`
-    + Added `set_speed` method:  Use `set_speed` to change the speed at which motors should turn. Can be any value between 0.0 and the default 1.0 (maximum speed)
+    - `forward_pin` and `backward_pin`are now `u8`
+    - Added `set_speed` method: Use `set_speed` to change the speed at which motors should turn. Can be any value between 0.0 and the default 1.0 (maximum speed)
 
-* **device**
+- **device**
   - Renamed `GPIODevice` to `GpioDevice`