openlab-report-template's Introduction

openlab report template

A LaTeX template for the project report of CERN openlab summer students. Take a look at the document preview here.

It is based on LaTeX article class. Minimal customization has been added to match provided template.

Usage

Overleaf

To use this template on Overleaf:

Download this repository as a zip file
Go on Overleaf, click New Project and then Upload Project
Select the zip file downloaded in step 1
You're done! The report will get compiled and you'll see a live preview on the right :) You can start writing your report in the main.tex file.

Local

Use the traditional instructions, e.g.:

pdflatex --shell-escape main.tex
biber main
pdflatex --shell-escape main.tex

A makefile is also included for convenience. make pdf will build the PDF for you, provided you have all the dependencies installed on your system.

Document structure

Full structure of this template is placed below. You need to edit main.tex providing details of your project (title, names, specifications, abstract) and the content of the report. Bibliography in BibTeX can be placed in bibliography.bib.

To present the main features of this template, a dummy text is written in demo/. Delete such folder when developing your own project.

.
|-- assets
|   |-- cern_openlab_logo.png
|   |-- cern_openlab_logo_small.png
|   |-- front.png
|   |-- hline1.png
|   `-- hline2.png
|-- demo
|   |-- demo.tex
|   |-- smile.png
|   `-- tikz.tex
|-- bibliography.bib
|-- main.tex
|-- README.md
`-- openlabreports.cls

openlabreports.cls and assets contain customization of LaTeX article to CERN openlab theme.

Figures, code snippets, bibliography

Examples are given in the template, but please consult LaTeX documentation for further details. For instance, visit Overleaf webpage.

Contributing

Contributions are welcome! Please open a PR for any improvement.

License

Recommend Projects

baronefr / openlab-report-template Goto Github PK