oedokumaci / templatex

Template repository for Latex projects.

Templatex

This is a LaTeX project template to kick start your research paper or document projects with a standardized structure and tools.

Getting Started

1. Install Python >=3.11 in your local machine.
2. Click on the Use this template button at this page to create a new repository from this template (you must be logged in to GitHub to see the button).
3. Name your repository and click Create repository from template. If the repository name is more than one word, make sure to use -hyphens- instead of spaces or underscores.
4. Git clone the repository to your local machine.
5. Cd into the repository directory.
6. There is a Makefile in the project directory, run make setup to setup the project. You can run make help to see the available commands as below. The Makefile is also used in the CI/CD pipeline.
7. Remember to edit this README file to reflect your project details.