From 3ca504e54b34430de92630cb1a0f9fa947be9616 Mon Sep 17 00:00:00 2001 From: Olivier Le Thanh Duong Date: Tue, 25 Jul 2023 17:03:25 +0200 Subject: [PATCH] Add installation instructions in the documentation --- doc/index.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/index.rst b/doc/index.rst index b1dd4ef..8a30522 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -17,6 +17,28 @@ This module has been originally developed by :local: :depth: 1 +Installation +============ + +Basic Installation using pip +---------------------------- +Before you begin, ensure that the libsane-dev package is installed on your system. This is a required dependency. + +On Debian-based system (like Ubuntu), you can install libsane-dev using the apt package manager. + + apt install libsane-dev + +Then install the packages via pip + + pip install python-sane + + +Building from sources +--------------------- + +You can find the instructions on how to build and install from sources in the main README.rst + + Indices =======