aboutsummaryrefslogtreecommitdiff
path: root/docs/onboarding/installing.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/onboarding/installing.rst')
-rw-r--r--docs/onboarding/installing.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/onboarding/installing.rst b/docs/onboarding/installing.rst
new file mode 100644
index 0000000..4fee3ca
--- /dev/null
+++ b/docs/onboarding/installing.rst
@@ -0,0 +1,35 @@
+Installing thcolor
+==================
+
+In order to run and tweak thcolor, you must first install it; this section
+will cover the need.
+
+Dependencies
+------------
+
+thcolor dependencies are pure Python dependencies, automatically installed
+when using a package manager such as pip:
+
+ * regex_, used for parsing color expressions.
+
+Installing thcolor using pip
+----------------------------
+
+To install thcolor, you can use pip with the following command:
+
+.. code-block:: sh
+
+ python -m pip install thcolor
+
+Some notes on this command:
+
+ * On most Linux distributions, you can directly call ``pip`` (or ``pip3``
+ on those where Python 2.x is still the default); I personnally prefer
+ to call it through Python as a module.
+ * On Linux and other UNIX-like distributions where Python 2.x is still the
+ default, when Python 3.x is installed, you must usually call it using
+ ``python3`` instead of ``python``.
+ * On Microsoft Windows, the Python executable, when added to the PATH,
+ goes by the name ``py`` instead of ``python``.
+
+.. _regex: https://pypi.org/project/regex/