Autonomous Instantdocument System

Table of Contents

Table of Contents

• About The Project
  • Features
  • Planned
• Getting started
  • Requirements
  • Installation
    • Windows
    • UNIX (BSD, GNU/Linux)
• Usage

About The Project

Features

• Generate LaTeX documents
• Usable via GUI, TUI (UNIX OS only) and CLI

Planned

• Customizable LaTeX snippets (preconfigured for exams and answers)
• Snippet usage saved in a database
• Export database to CSV
• ChatGPT integration to automatically generate new snippets (API-key required)

Getting started

Requirements

• maven
• java20
• JavaFX
• pdflatex
• whiptail (for TUI)

Installation

Windows

Build and install with these commands.

mvn package -DskipTests
xcopy "distribution\target\autonomous-instantdocument-system.jar" "C:\Program Files\autonomous-instantdocument-system.jar" /Y
xcopy "distribution\assets\defaults\*" "%appdata%\aids" /E /Y

NOTE: -DskipTests is not necessary, it's just making the process go much faster. If you want to run tests anyway, you need to install the config-files first.

It is recommended that you define an alias If you want to launch from the command line

doskey autonomous-instantdocument-system="java -jar C:\Program Files\autonomous-instantdocument-system.jar"

UNIX (BSD, GNU/Linux)

Build and install with these commands.

mvn package -DskipTests
sudo cp distribution/target/autonomousInstantdocumentSystem.jar /opt/autonomous-instantdocument-system/autonomous-instantdocument-system.jar
sudo cp distribution/autonomous-instantdocument-system-cli /usr/local/bin # optional
gzip -c docs/man/autonomous-instantdocument-system.1 | sudo tee /usr/share/man/man1/autonomous-instantdocument-system.1.gz >/dev/null

NOTE: -DskipTests is not necessary, it's just making the process go much faster. If you want to run tests anyway, you need to install the config-files first.

It is recommended that you define an alias If you want to launch from the command line

alias autonomous-instantdocument-system="java -jar /opt/autonomous-instantdocument-system/autonomous-instantdocument-system.jar":

Usage

Running autonomous-instantdocument-system without options launches a graphical interface.

Flags

flag	function
-t --type	Specifies the desired Document type, e.g. "exam".
-c --chapters	Specifies the amount of chapters per document.
-a --amount	Specifies how many Documents should be generated.
-s --shuffle	Turns the shuffle mode on.
-h --help	Show summary of options.
-v --version	Print version number and exit.