Merge branch 'master' of https://github.com/medevil84/FanControl.Aqua…

…computerDevices

README.md

@@ -1 +1,45 @@
-# FanControl.AquacomputerDevices
+
+# FanControl.AquacomputerDevices
+[FanControl](https://github.com/Rem0o/FanControl.Releases) Plugin for the Aquacomputer Devices (HighFlowNext, Quadro and *Highly Experimental* Octo)
+
+This plugin will interface directly with the usb devices, so *aquasuite is not needed*.
+> This code has been tested with firmware version >= 1012 of the **HighFlowNext** device.
+
+> This code has been tested with firmware version == 1032 of the **Quadro** Device.
+
+
+## USE THIS SOFTWARE AT YOUR OWN RISK!
+The _FanControl.AquacomputerDevices_ main developer is running this software, without any negative side effects. However, it is a **highly experimental software**, and it is based on reverse engineering only.
+
+* This software might damage your Aquacomputer devices in a way that it must be repaired or replaced.
+* The use of this software could lead to failure of cooling fans or aqua pumps, which might cause permanent damage to heat sensitive components of your system.
+* Using this software might void your warranty.
+
+Neither the _FanControl.AquacomputerDevices_ developers nor the manufacturer can be held liable for any damage caused by this software.
+
+It is strongly recommended to use only the official software!
+
+
+## Installation
+Copy the dll files to the \Plugins folder. Make sure that Windows did not automatically block the files (uncheck the "Unblock" property).
+### _*** If you are using other FanControl plugins for quadro or highflownext, please uninstall them ***_
+
+## Experimental Octo Support
+Since Quadro and Octo devices are quite similiar, the Octo part has been implemented in the code but has not been enabled. If you would like to test it, please download the source code in visual studio, uncomment line 19 of the file [Device/DeviceHelpers.cs](https://github.com/medevil84/FanControl.AquacomputerDevices/blob/master/FanControl.AquacomputerDevices/Devices/DevicesHelpers.cs#L19) and recompile.
+
+## Contribute
+
+* Fork the [Source code at GitHub](https://github.com/medevil84/FanControl.AquacomputerDevices). Feel free to send pull requests.
+* Found a bug? [File a bug report!](https://github.com/medevil84/FanControl.AquacomputerDevices/issues)
+
+## License
+
+_FanControl.AquacomputerDevices_ is open source software. The source code is distributed under the terms of [GNU Lesser General Public License (LGPLv3)](https://www.gnu.org/licenses/gpl-3.0.en.html#content).
+
+## Acknowledgements
+
+ - [FanControl](https://github.com/Rem0o/FanControl.Releases) for providing a great software ( _would be greater if it was open sourced too :P_ )
+ - [HidLibrary](https://github.com/mikeobrien/HidLibrary) for providing a clean and easy to use usb hid library.
+ - [aquacomputer-quadro-control](https://github.com/leoratte/aquacomputer-quadro-control) was used to understand how to apply settings to the device.
+ - [dnSpy](https://github.com/dnSpy/dnSpy) helped a lot during the reverse engineerying
+ - [WireShark](https://www.wireshark.org) for reverse engineering. Without this tool, no "control" part of the quadro would be available.