README.md

LaTeX Submodule

Set up your LaTeX projects quickly using GitHub submodules!

---

Importing the submodule

To add this submodule to your LaTeX project, use the following command:

# HTML
git submodule add https://github.com/Tarang74/LaTeX-Submodule
# SSH
git submodule add [email protected]:Tarang74/LaTeX-Submodule.git

Initialising the submodule

If you are using a project that contains this submodule, initialise it with the following commands:

git submodule init
git submodule update --remote

Copying the ignore file

Use the following commands if you want to use the provided .ignore file.

Linux & macOS

cp LaTeX-Submodule/.gitignore .gitignore

Windows

copy LaTeX-Submodule\.gitignore .gitignore

Using the styles

To use the definitions in template.tex, place the following command in the preamble of your document.

\input{LaTeX-Submodule/template.tex}

Using the make_figures batch script

make_figures.bat is designed to compile multiple .tikz files from the root directory of the program. The figures are compiled to PDFs and are stored in ./figures.

To compile a single file, use:

make_figures file [directory] [filename] [options]

To compile all .tikz files in a directory use:

make_figures recursive [directory] [options]