instructions update with contribute

README.md

@@ -2,25 +2,26 @@
 
 This repository contains all presentations related to R3.
 
-# How to get started
+## Prerequisites
 
-Copy the presentation template folder into the folder of the current year and name it
-according to your preference, i.e. `YYYY-MM-DD_myPresentation`.
+In order to use the slide deck, you must have:
 
-```bash
-$ cd YYYY-MM-DD_myPresentation
-$ npm install -g npm@latest grunt-cli generator-reveal
-$ npm install
-```
+- Python 3 installed. It is recommend to use a virtual environment.
+- Node.js installed. Instructions for are here for [macOS](https://wsvincent.com/install-node-js-npm-mac/) and [Windows](https://wsvincent.com/install-node-js-npm-windows/).
+- 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:
 
-# How to develop locally
+## How to get started
 
-```bash
-$ grunt server
-```
+- 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"
+    ```
 
-# How to publish
+**Note**: a new branch is automatically created. If you are ready making changes to your presentation, push your changes to your fork and open a merge request against the `develop` branch.
 
-```bash
-$ grunt dist
-```