rewrite README with new install

This commit is contained in:
Bela 2018-11-02 18:31:05 +01:00
parent da8de8c23a
commit 3bbe6b367a

38
README
View file

@ -1,16 +1,28 @@
reisefill is a project to simplify filling out pdf forms.
Two scripts are available:
• fillform: fills a pdf form by asking you questions
• readformdata: helps for creating config files that can be used by fillform
Both have some help available via the option --help/ -h.
INSTALLATION
============
Call the script
./install.py
to install the scripts fillform, reise and uninstall-fillpdf and add a config file.
For options in the install call:
./install.py --help
USE
===
Several scripts are available:
• reise: creates a new directory with all files necessary for a business trip
• fillform: fills a pdf form by asking you questions. Should be run in a directory created with 'reise'
• uninstall-fillpdf: remove the links in the PATH that were created during install
• ./readformdata.py: helps for creating config files that can be used by fillform
All of them have some help available via the option --help/ -h.
The configuration file syntax is decribed in doc/configspecification.
Prerequisites:
for fillform one needs the python module fdfgen.
https://github.com/ccnmtl/fdfgen
Either install fdfgen with
pip3 install fdfgen
or copy the file https://github.com/ccnmtl/fdfgen/blob/master/fdfgen/__init__.py
to somewhere python can find it (e.g. project directory) and call if fdfgen.py
for fillform one needs the command line programm pdftk
Prerequisites
=============
• python3 in /usr/bin/python3
• pdftk: for fillform the command line programm pdftk must be installed