summaryrefslogtreecommitdiffstats
path: root/doc/installation.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:25:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-07-26 05:34:52 +0000
commit9ecff41dd11e920286f9be670a0ec3a668371d1d (patch)
tree89c73ab6742847ca5f12056e6c0dd4ec6bbe79d0 /doc/installation.rst
parentAdding debian version 1.0-1. (diff)
downloadlibnvme-9ecff41dd11e920286f9be670a0ec3a668371d1d.tar.xz
libnvme-9ecff41dd11e920286f9be670a0ec3a668371d1d.zip
Merging upstream version 1.1~rc0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/installation.rst')
-rw-r--r--doc/installation.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644
index 0000000..0bc8f99
--- /dev/null
+++ b/doc/installation.rst
@@ -0,0 +1,52 @@
+Installation
+============
+
+Debian / Ubuntu:
+--------------
+
+.. code-block:: sh
+
+ $ apt-get install libnvme
+
+Fedora / Red Hat:
+--------------
+
+.. code-block:: sh
+
+ $ dnf install libnvme
+
+Python Version
+--------------
+
+The latest Python 3 version is always recommended, since it has all the latest bells and
+whistles. libnvme supports Python 3.6 and above.
+
+Dependencies
+------------
+
+libnvme only uses packages from the standard library,
+so no additional dependencies will be installed when installing libnvme.
+
+Install libnvme python
+-------------
+
+Debian / Ubuntu:
+
+.. code-block:: sh
+
+ $ apt-get install python3-libnvme
+
+Fedora / Red Hat:
+
+.. code-block:: sh
+
+ $ dnf install python3-libnvme
+
+libnvme is available on `PyPI`_, and can be installed using pip. The version on PyPI is
+always the latest stable release.
+
+.. _PyPi: https://pypi.org/project/libnvme/
+
+.. code-block:: sh
+
+ $ pip install libnvme