gryf/linak-ctrl
1
0
Fork 0
mirror of https://github.com/gryf/linak-ctrl.git synced 2025-12-19 12:18:05 +01:00
Code Issues Projects Releases Wiki Activity

Readme update.

Browse Source
This commit is contained in:
gryf
2021-07-07 17:49:45 +02:00
parent e9ea91f2c3
commit 9a33f742e1
1 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.rst
View File

@@ -2,6 +2,9 @@
Linak-ctrl Linak-ctrl
========== ==========
.. image:: https://badge.fury.io/py/linak-ctrl.svg
:target: https://badge.fury.io/py/linak-ctrl
Simple python script to control Linak powered desks and USB2LIN06 cable. Simple python script to control Linak powered desks and USB2LIN06 cable.
@@ -14,6 +17,31 @@ Requirements
* `pyusb`_ * `pyusb`_
Installation
============
There are couple of different ways for installing ``linak-ctrl``. One of the
preferred ways is to use virtualenv and pip:
.. code:: shell-session
$ git clone https://github.com/gryf/linak-ctrl
$ cd linak-ctrl
linak-ctrl $ python -m venv linak
(linak) linak-ctrl $ pip install .
(linak) linak-ctrl $ linak-ctrl status
Position: 767, height: 78.80cm, moving: False
Or, you can install it system-wide:
.. code:: shell-session
$ sudo pip install linak-ctrl
And finally, you could also install dependences from your system repositories,
and use script directly, by placing it somewhere in your ``$PATH``.
Usage Usage
===== =====