summaryrefslogtreecommitdiffstats
path: root/doc/installation.rst.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/installation.rst.in')
-rw-r--r--doc/installation.rst.in55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/installation.rst.in b/doc/installation.rst.in
new file mode 100644
index 0000000..ea0415d
--- /dev/null
+++ b/doc/installation.rst.in
@@ -0,0 +1,55 @@
+Installation
+============
+
+Debian / Ubuntu:
+----------------
+
+.. code-block:: sh
+
+ $ apt-get install libnvme
+
+Fedora / Red Hat:
+-----------------
+
+.. code-block:: sh
+
+ $ dnf install libnvme
+
+Python binding
+--------------
+
+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