From 793eeab5ca841cca400002ae7580b9ce4d675d7a Mon Sep 17 00:00:00 2001 From: Jordan ERNST Date: Thu, 20 Jun 2019 16:33:18 +0200 Subject: [PATCH] Update README to include build instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5fdcf1c..9253d90 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ # IFPass -IFPass is a python project developped for the "Institut Français en Hongrie" and published under MIT license. +IFPass is a python project developped for the "Institut Français en Hongrie" and published under [MIT license](https://framagit.org/SecT0uch/IFPass/blob/master/LICENSE). It allows to manage a subscriber database and print member cards. + +## Build + +1. Install [NSIS](http://nsis.sourceforge.net/Download). +2. Install python 3 and pip. +3. Install the modules with `sudo -H pip install pynsist PyPDF2 termcolor` +4. If pynsist version < 2.4, replace `/usr/lib/python3.*/site-packages/nsist/__init__.py` with https://raw.githubusercontent.com/takluyver/pynsist/master/nsist/__init__.py +5. Run `./build.sh` +