AutoLTX/README.md

AutoLTX

Automated build system for compiling Latex Files, mimicing the Overleaf build system.

1. Build the docker container using:

docker build -t autoltx:latest .

2. Download the overleaf project as a zip file or using the git integration to easily push any changes.

3. Use the following command to attach the project folder to the built container.

docker run --rm -it -e "mainFile=<mainTEXfile>" -v <projectFolderPath>:/app/project:z --user 1000:1000 autoltx:latest

replace <mainTEXfile> with the primary tex file to compile, <projectFolderPath> with the path to the project folder.

This will compile your project whenever a change is observed in the mainTEXfile file.

Observables:

• The container will create a new folder pdf which contains all the build files.
• Once the project compiles, the result is put into the <projectFolderPath>, called output.pdf. Keep it open so any changes to the main tex file, triggers a pdf update. Other files include compile.sh: the main compilation script, latexmkrc: used by the latexmk compiler, edit cautiously, and .autoltx: used for versioning the container scripts.
• These files are added to gitignore if present to avoid tracking unnecessary files by git.