Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
boosterl committed May 15, 2019
1 parent d8c3b25 commit c0ed36a
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# eid-image-extractor
A simple python script to extract the image from a Belgian E-ID card
## Introduction
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:
```
sudo pacman -S python3 swig
sudo pip install eidreader
```

## How to use
After you installed the dependencies, you can just run the script:
```
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.

0 comments on commit c0ed36a

Please sign in to comment.