https://github.com/xiaoxiae/soc-paper-2019

The source code to my SOČ paper for the year 2019.
https://github.com/xiaoxiae/soc-paper-2019

education latex paper robotics soc

Last synced: 7 days ago
JSON representation

The source code to my SOČ paper for the year 2019.

• Host: GitHub
• URL: https://github.com/xiaoxiae/soc-paper-2019
• Owner: xiaoxiae
• License: mit
• Created: 2019-01-17T21:29:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-17T05:57:40.000Z (over 5 years ago)
• Last Synced: 2025-01-07T06:35:06.463Z (9 days ago)
• Topics: education, latex, paper, robotics, soc
• Language: TeX
• Homepage:
• Size: 19.1 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SOČ paper 2019

This repository contains the source code to my 2019 [SOČ](http://www.soc.cz/) paper (written in LaTeX). It describes the work and the thought process behind [robotics-simplified.com](http://robotics-simplified.com/).

The presentation about the paper can be found [here](https://github.com/xiaoxiae/soc-presentation-2019)

## Compiling the paper

If you want to use the project as a template for your own SOČ paper, or to compile the paper, there are some things you should know before doing so.

### Typesetting system

The paper was converted to PDF using **LuaTeX**. It was chosen mainly for its out-of-the-box UFT-8 support (which pdfTeX lacks). It comes with most of the major TeX distributions like TeX Live and MiKTeX, so you should already have it installed.

[compile.py](scripts/compile.py) is the script that was used to build the paper. I would recommend you either use it directly or run the same commands in the command line to properly render things like bibliography or the list of acronyms.

### Code Highlights

_If you don't need code highlights, simply remove `\usepackage{minted}` from `paper.tex` and skip the rest of this section._

Code highlights in the paper use the minted package, which uses **Pygments** (a Python syntax highlighter). To install it, run this command in your terminal:

```

pip install Pygments

```

You can then run `pygmentize -V` to ensure that the program installed correctly. Keep in mind that you will need to run the compilation with the `--shell-escape` option to allow shell interaction (see [compile.py](scripts/compile.py)).

### Fonts

The font **CMU Serif** was used to typeset the (majority of the) paper, mainly due to it's bold small caps support that SOČ requires for certain headings. Make sure to have it [installed](https://sourceforge.net/projects/cm-unicode/) either on your system or through your TeX distribution if you plan on using it.

You can also use a different system font by changing the line `\setmainfont{CMU Serif}` in `paper.tex`.

The paper also uses **FontAwesome5** and the fontawesome5 package to typeset certain symbols and icons. You can either remove the line `\usepackage{fontawesome5}` from `paper.tex` if you don't plan on using any of the icons, or [install the font](https://fontawesome.com/download) on your system.