From 8f0143ac79e899a5c59b37cca63046d1db976f16 Mon Sep 17 00:00:00 2001 From: gryf Date: Sat, 27 Feb 2021 19:14:23 +0100 Subject: [PATCH] Added README. --- README.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0f81477 --- /dev/null +++ b/README.rst @@ -0,0 +1,45 @@ +========== +Linak-ctrl +========== + +Simple python script to control Linak powered desks and USB2LIN06 cable. + + +Requirements +============ + +* Linak desk ;) +* USB2LIN06 device +* Python +* `pyusb`_ + + +Usage +===== + +.. TBD. + + +Alternatives +============ + +There are two projects, which more or less are doing the same. Fist one can be +treated as a reference project - lots of information in the source code, second +one is a python project, which uses `libusb1`_ wrapper library instead of +`pyusb`_: + +* `usb2lin06-HID-in-linux-for-LINAK-Desk-Control-Cable`_ +* `python-linak-desk-control`_ + + +License +======= + +This software is licensed under 3-clause BSD license. See LICENSE file for +details. + + +.. _pyusb: https://github.com/pyusb/pyusb +.. _usb2lin06-HID-in-linux-for-LINAK-Desk-Control-Cable: https://github.com/UrbanskiDawid/usb2lin06-HID-in-linux-for-LINAK-Desk-Control-Cable +.. _python-linak-desk-control: https://github.com/monofox/python-linak-desk-control +.. _libusb1: https://github.com/vpelletier/python-libusb1