Prerequisites and Learning Resources - JonasEngstrom/overleaf-article-template GitHub Wiki

This is a list of software and services required to use the template along with some suggested reading for those wishing to learn more.

Bash

Bash or a compatible shell is needed to run shell scripts, such as sync.sh. If you are running a Linux or UNIX system (such as macOS) this should not be a problem. LinuxCommand.org describes how to use Bash.

Git

Git provides the core functionality behind the template. On macOS Git is included with the XCode command line tools, which need to be manually installed. Otherwise Git comes prepackaged with many operating systems, but can also be downloaded separately. The GitHub Docs have an introduction to Git.

GitHub

Since you are reading this wiki, chances are you are already familiar with GitHub. If not, their own documentation explains how to get started.

GitHub Command Line Tools

The GitHub Command Line Tools are not strictly necessary but can speed up some aspects of working with the template. The GitHub CLI Manual lists the available commands, while the Getting Started section of the GitHub docs descries how the commands might be used.

Overleaf

Git integration is an Overleaf premium feature, which means that at least the person starting a new project with the template needs to have a paid subscription. Overleaf also has many helpful LaTeX guides.

Python

Python is used by Git hooks in the template. While the user ideally should not have to deal with the scripts themselves, familiarity with the language may be helpful as it can also be used in R Markdown documents. For those with prior programming experience a read through of the Python Docs Tutorial will be enough. For complete beginners DataCamp offers several learning paths—see also the note on discounts under R.

R

R is required to run RStudio and R Markdown. DataCamp has several good R learning paths. Discounts and extended free trial periods are often offered, e.g. by Microsoft.

R Markdown

R Markdown is the language used to write documents including graphics that can then be exported as LaTeX and synced to Overleaf using the template. The language is simple enough to be used by a beginner with a cheat sheet but there is also more thorough documentation available.

RStudio

RStudio is not required but highly recommended for running R Markdown. RStudio Education has some suggested reading for the fledgling R user.