summaryrefslogtreecommitdiffstats
path: root/docs/source/installation.rst
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-07-12 22:13:14 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2020-07-12 22:13:14 -0500
commit641f68125f317f736110b71fb9a1b9725d8e3771 (patch)
treec7db87eb35c32e85ad416ab1cf7472f6891b2721 /docs/source/installation.rst
parentConvert docs to rst and add CONTRIBUTING guidelines (diff)
downloadlirc-641f68125f317f736110b71fb9a1b9725d8e3771.zip
Add rtd docs
Diffstat (limited to 'docs/source/installation.rst')
-rw-r--r--docs/source/installation.rst38
1 files changed, 38 insertions, 0 deletions
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