README.md

# Presentation slides

This repository contains all presentations related to R3.

## Prerequisites

In order to use the slide deck, you must have:

- **git**: For convenience, have your SSH key configured on git-r3lab. [Here](https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html) is how to do it:
- **Python 3**: It is recommend to use a virtual environment.
- **Node.js**: Instructions for are here for [macOS](https://wsvincent.com/install-node-js-npm-mac/) and [Windows](https://wsvincent.com/install-node-js-npm-windows/).

## How to get started

- Fork this repository
- Clone your fork
    ```bash
    $ git clone ssh://git@git-r3lab-server.uni.lu:8022/<yourUsernam>/presentations.git
    ```
- Open a terminal and work on your presentation:
    ```bash
    $ cd presentations
    $ python contribute.py --date="YYYY-MM-DD" --name="yourAwesomeTitle"
    ```

**Note**: The first time you run `contribute`, a new branch is automatically created with the name `YYYY-MM-DD_yourAwesomeTitle`.

If you are done with making changes to your presentation, push them to your fork and open a merge request against the `develop` branch.