From 9b984fb8de7cd35874fe11f27df7c05edcbc43b9 Mon Sep 17 00:00:00 2001
From: gryf <git@vimja.com>
Date: Tue, 23 Feb 2021 19:26:24 +0100
Subject: [PATCH] Change README format to reST, typical for python application.

---
 README.md  | 40 ---------------------------------
 README.rst | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 40 deletions(-)
 delete mode 100644 README.md
 create mode 100644 README.rst

diff --git a/README.md b/README.md
deleted file mode 100644
index 8b4f16c..0000000
--- a/README.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# python-linak-desk-control
-
-This is a simple program for controlling LINAK Desk Control Cable in linux with simple python and libusb.
-
-Its a python implementation of [C-Routine of ranma1988](https://github.com/ranma1988/usb2lin06-HID-in-linux-for-LINAK-Desk-Control-Cable)
-
-Tested on: Gentoo x64 (December 2018). Might work on Windows too.
-Tested on model: usb2lin06 with CONTROL BOX CBD6S without safety limit.
-
-### Dependencies
-this is using: **libusb-1.0**
-```sh
-$ pip install -r requirements.txt
-```
-
-The installation of libusb1 package of python may need to have the libusb-1.0 devel packages installed on most linux systems.
-
-### Capabilities
-* setting height
-* retrieve current height
-
-### Usage
-Just trying out in your shell is easy:
-```sh
-$ python3 linak-desk-control.py
-```
-
-It will show you mostly the whole help in order to understand which commands can be executed.
-E.g. to get the current height:
-```sh
-$ python3 linak-desk-control.py height
-```
-
-And to bring the desk to height 4414:
-```sh
-$ python3 linak-desk-control.py move 4414
-```
-
-### License 
-This piece of work is distributed with GNU GPLv3 or later.
\ No newline at end of file
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..aa4f3ab
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,66 @@
+=========================
+python-linak-desk-control
+=========================
+
+This is a simple program for controlling LINAK Desk Control Cable in linux with
+simple python and `libusb1`_.
+
+It's a Python implementation of `C-Routine of ranma1988`_
+
+Tested on: Gentoo x64 (December 2018). Might work on Windows too.
+Tested on model: usb2lin06 with CONTROL BOX CBD6S without safety limit.
+
+Dependencies
+------------
+
+This program is using `libusb1`_ which is python wrapper on `libusb` C library.
+You can install it by searching for appropriate package in you operating system
+(i.e. there is a ``python3-libusb1`` package for Ubuntu), or build by yourself
+issuing following command:
+
+.. code:: shell-session
+
+   $ pip install -r requirements.txt
+
+Note, that for build process, you might need to have devel packages for
+`libusb`_ C library installed.
+
+Capabilities
+------------
+
+* setting height
+* retrieve current height
+
+Usage
+-----
+
+Just trying out in your shell is easy:
+
+.. code:: shell-session
+
+   $ python3 linak-desk-control.py
+
+It will show you mostly the whole help in order to understand which commands
+can be executed. E.g. to get the current height:
+
+.. code:: shell-session
+
+   $ python3 linak-desk-control.py height
+
+And to bring the desk to height 4414:
+
+.. code:: shell-session
+
+   $ python3 linak-desk-control.py move 4414
+
+
+
+License
+-------
+
+This piece of work is distributed with GNU GPLv3 or later.
+
+
+.. _libusb1: https://github.com/vpelletier/python-libusb1
+.. _C-Routine of ranma1988: https://github.com/ranma1988/usb2lin06-HID-in-linux-for-LINAK-Desk-Control-Cable
+.. _libusb: https://libusb.info