From 9a33f742e16fd189a44dd0ccff746d604c916911 Mon Sep 17 00:00:00 2001 From: gryf Date: Wed, 7 Jul 2021 17:49:45 +0200 Subject: [PATCH] Readme update. --- README.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.rst b/README.rst index ecb8224..ee7113b 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,9 @@ 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. @@ -14,6 +17,31 @@ Requirements * `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 =====