ReporTeX

⚠️ This project is no longer actively maintained: feel free to contact me if you need more information.

ReporTeX is a Python script which is designed to generate a specific LaTeX template. The main goal of this tool is to help users focusing as much as possible on the content and not on the layout.

Table of contents

• Requirements
• How to start
• License

Requirements

• A TeX distribution
• An editor
• Python
  • colorama

How to start

1. Download the ReportMaker
   • Option 1: Download the full repository: git clone git://github.com/sljrobin/ReporTeX/.git
   • Option 2: Download only the ReportMaker
     • Go to the ReportMaker source webpage
     • Right click on the Raw button
     • Select Save Link As...

• Download the last version of the class if you downloaded only the ReportMaker: python reportmaker.py -d
• Create a new report: python reportmaker -n
• Generate the [makefile]: python reportmaker -m

Content

The following files and folders will be created after executed the commands described in the How to start section.

• makefile Makefile
• report/ Main folder
  • assets/` Non-TeX files
    • codes/ Source code
    • graphics/ TikZ files
    • images/ Figures
    • tables/ Tables
  • back/ Back
  • chapters/ Chapters
  • prelims/ Prelims
• reportex.cls LaTeX class
• report.tex Main file

Options

• ReportMaker
  • -d, --download: download the ReporTeX class
  • -h, --help: show the help
  • -m, --makefile: generate the makefile
  • -n, --new: create a new report
  • Usage: python reportmaker.py <option>
• Makefile
  • archive-tar: compress the files in a .tar.gz archive
  • archive-zip: compress the files in a .zip archive
  • build-full: clean and compile
  • build-simple: compile only the main file
  • clean: remove the odd files
  • view: read the PDF
  • Usage: make <option>

License

The content of this project is licensed under the GPL license.