From 3bbb512638f25d523c23c5a06c28c87dec336895 Mon Sep 17 00:00:00 2001 From: Bram Oosterlynck Date: Tue, 30 May 2023 17:32:06 +0200 Subject: [PATCH] Update README --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4199de1..0ee623e 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,26 @@ # eid-image-extractor + ## Introduction -This is a small python script to extract the image from a Belgian electronic identity card. + +This is a small python script to extract the image from a Belgian electronic +identity card. ## How to install -Before running this script you will need a few dependencies, notably, python 3, pip3 and the python module [eidreader](https://github.com/lino-framework/eidreader). -To install eidreader you will also need to have ```swig``` installed. On an Arch system, the installation looks like this: +All the Python dependencies this script has are declared in the +`requirements.txt`-file. The script can be ran in a `venv`: ``` -sudo pacman -S python3 swig -sudo pip install eidreader +python3 -m venv . +source ./bin/activate +pip install -r requirements.txt ``` ## How to use -After you installed the dependencies, you can just run the script: + +After you installed the dependencies, you can just run the script inside the +`venv`: ``` python3 eid-image-extractor.py ``` -After this, if everything went well, you will see a file with the name ```{NATIONAL_NUMBER}.jpeg``` next to the script. +After this, if everything went well, you will see a file with the name +```{NATIONAL_NUMBER}.jpeg``` next to the script.