From 641f68125f317f736110b71fb9a1b9725d8e3771 Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sun, 12 Jul 2020 22:13:14 -0500 Subject: Add rtd docs --- docs/source/installation.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/source/installation.rst (limited to 'docs/source/installation.rst') diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 0000000..fa20733 --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,38 @@ +Installing the LIRC Python Package +================================== + +Since this package is merely a wrapper around the LIRC +daemon, it is expected that LIRC is installed and setup +on the given system as well to be able to use the python +package. + +Python Package +-------------- + +This package is hosted on PyPI and can be installed +through pip. + +.. code-block:: bash + + $ pip install lirc + +System LIRC Package +------------------- + +While there are ports of LIRC to macOS and Windows, +the original Linux version is much easier to get +working and install. + +Linux: + + * It is highly likely that the package manager on + your system already has LIRC packaged up and ready + to be installed for you. + +Windows: + + * WinLIRC at http://winlirc.sourceforge.net/ is a port for Windows. + It works a bit differently since it is just a collection of files + in a folder that you run so you'll have to adjust the ``socket`` + and ``socket_path`` parameter. More information on that can be found + at `Using LIRC on Windows <./using-lirc-on-windows.html>`_. \ No newline at end of file -- cgit v1.2.3