UniTeX

UniTeX is a collection of scientific oriented and minimalistic LaTeX templates suitable for many assignment types.

Table of contents

• Requirements
  • TeX
  • Shell
  • PDF viewer (optional)
• Installation
• Quick start
• Screenshots
  • Classic
  • Article
  • Homework
  • Cover Letter
• Features
• TODO
• Credits

Requirements

TeX

UniTeX requires a complete TeX distribution (you can find the most used TeX distributions here). Most features need external tools such as latexmk that fully automates LaTeX document generation. Latexmk is usually part of TeX distributions like MikTeX and MacTeX but you can always install it separately by following these steps.

Shell

A Unix shell is also required to install UniTeX properly. Commands such as mkdir, cp, ln and others are used within install script and makefiles so it's important for you to have access to this type of shell to install UniTeX correctly.

PDF viewer (optional)

A pdf viewer like Skim, Zathura and SumatraPDF is also fun to have when working on LaTeX projects.

Installation

The ideal way to install UniTeX is via the install script install.sh.

$ git clone https://github.com/BCarnaval/UniTeX
...
$ cd UniTeX && chmod +x install.sh && ./install.sh

By doing it like so, you will be able to use UniTeX's commands unitex -h.

Usage outputed by unitex

Quick start

Once installation properly done and unitex -h command outputs no error, you can directly build your first UniTeX template

1. Select a directory (folder) on your machine in which store template's files that you'll edit later. For the example, we will use a folder named test in home directory.

$ mkdir ~/test

2. Build your template inside this directory using unitex by specifying the flags -b build: template (classic, article, homework, cover), -d directory: directory in which build it (directory created in step 1.) and -o opt: building options (clean, dry, targz, zip or empty to tell latexmk to continuously compile your project on save).

$ unitex -b classic -d ~/test -o dry

Here, the dry option means that latexmk will not compile your project continuously and not clean the directory either. It will simply build the template inside the specified directory and leave all files there. To clean it, you must use the option clean with the -o flag. These commands being done (dry and clean), you should have the following content inside your test folder

$ ls ~/test
Makefile
PageTitre.tex
colors.sty
commands.sty
figs/
main.pdf
main.tex
refs.bib
sections/
style.sty

3. If you read this I am assuming that your test directory isn't missing any files and you now are ready to configure/customize the template to satisfy the nature of your project. To do this, you simply open your favorite text editor and remove default values from PageTitre.tex, main.tex, all the files inside sections/ and figs/ directories, references from refs.bib and feel free to add your personnal commands inside commands.sty.

Screenshots

Classic

Example of what you should get from 'classic' template with Yale's darkblue as main color

Default title page	Sections layout

Maths display	References

Article

IN DEVELOPPEMENT

Homework

Example of what you should get from 'homework' template with Princeton's orange as main color

Default title page	Problem(s) presentation

Basic problem solving	References

Cover Letter

Example of what you should get from 'cover' template with Cornflower blue as main color

Default cover letter

Features

IN DEVELOPPEMENT.

TODO

• 'Classic' template
• Add MIT license
• 'Article' template (RevTeX)
• 'Cover Letter' template
• 'Homework' template (Overleaf's rebuild)
• Install/uninstall scripts
• Test on fresh Linux and Mac OS (Docker)
  • Installation fresh ubuntu (git & sudo post installed).
  • Build template.
• Man pages (MacOS, Linux)
• Version control
• REAME.md
• Add all well explained commands and features
• Setup default pdf viewer based on OS

Credits