German version / Deutsche Version: README_DE.md
A tool to replace placeholders in tex files with content from a given csv file.
Concrete use case: Automated generation of school reports as PDF.
To run the tool,
- check or download the content of this code repository
- run the script in your shell (command line):
$ ./runApplicationUsingGradle.sh The Gradle build tool will download all necessary libraries and launch the grahpical user interface (GUI).
As runtime environment, it is assumed that Java version 11 or higher is installed.
This may change in the future - it is the project's goal to be directly executable on a recent version of Ubuntu Linux.
One part of the required input data is the school report data in a CSV file.
This format is documented in docs/CSV_Format.md.
Another required part of the input is a .tex file with placeholders that will be replaced by the program with data
from the CSV.
These placeholders are documented in docs/TEX_Placeholders_Format.md.
For any such issues, please create an issue in the public GitHub repository
(==> link to GitHub issues <==).
You have to register as a user, but GitHub is free of charge.
Find the project's license here as a file.
At the time of writing, the project is licensed under the GNU General Public License (GPL)
- that means, any changes you make, you must disclose (and, ideally, offer to merge them back here).
Find a quick overview and simplified explanation here.
The flag emoji that are used are from OpenMoji and are licensed under CC BY-SA 4.0.