summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2021-04-18 18:47:34 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2021-04-18 18:47:34 -0500
commita54365a1d9e15c1657b0851021eb52c50d89e043 (patch)
tree35107d3b7aa92a17d151bf41a8eb650e23f28274
parentFix contributing guideline formatting (diff)
downloadlirc-a54365a1d9e15c1657b0851021eb52c50d89e043.zip
Add note to customizing client
-rw-r--r--README.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 71d18a8..07dd21f 100644
--- a/README.rst
+++ b/README.rst
@@ -109,8 +109,12 @@ As previously stated, we can customize these defaults if needed.
)
)
+For the client in the example above, we set it up using the defaults for a Linux machine.
+While this example illustrates what is customizable, it is not a practical example since
+you could call ``Client()`` with no arguments if you're on Linux and achieve the same outcome.
+
See `Overriding LIRC Defaults on Initialization <https://lirc.readthedocs.io/en/stable/usage.html#overriding-lirc-defaults-on-initialization>`_
-for more.
+for more information.
Sending IR
^^^^^^^^^^