Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.47 KB

Setup.md

File metadata and controls

58 lines (40 loc) · 2.47 KB

Setup the TUMGAD generator

Prerequisites

  1. LaTex: LaTeX is a well-known and widely used text presentation system. In essence LaTex compiles text written in a LaTeX (.tex) file and produces a pdf with tables, images, graphs, etc.

    You can get LaTeX here.

  2. Java Development Kit (JDK) >= 11. The JDK is used to run the actual Java code. Depending on your preferences, you can execute the jar or run the program in an IDE

    Get the JDK 13 here.

Adding to PATH

You have to add pdflatex to your PATH environment variable

On Windows and Linux the PATH should be set automatically, for macOS, you can look at the official instructions here.

You can check if you have LaTeX added by opening a new Terminal and simply typing pdflatex. If you don't get an error, it is set up correctly.

Installation

Due to a lack of functionality from eclipse, I strongly recommend you use IntelliJ IDEA. In Eclipse, you may need to install this plugin to show the colors in the console output.

  1. IDE (IntelliJ): New Project -> Project from version control ->

    New project from version control

    After this, you can simply click through the steps as usual.

  2. IDE (Eclipse): Clone a git repository ->

    New Project from VC in Eclipse

    After this, simply click through and add the project as usual

This only covered creating a project from version control, there are many other ways to create a project, I'm sure you'll find one that works for you.

Using the generator

You can find the only main method in src/Tumgad.java, after you execute it, you have the option to enter a seed. The same seed will produce the same exercises every time this makes it easier if you want to repeat more difficult exercises or share them.

After the seed, you can select which exercises should be generated enter your selections separated by a space (ex: TRAV AB AVL) or simply type X to generate everything.

Some PDF viewers cannot handle dynamic reloading of the PDF files, this means, depending on the PDF viewer, you might need to close the viewer before re-generating a file

Please note that the first execution might take exceptionally long, since LaTeX has to download a multitude of packages.