diff --git a/README.md b/README.md index 781016413c904e30ad1f2a40ab8241e170e6f52a..22d3b580eb2d75a34ac0b33ff3552218b389c16b 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ This repository contains all presentations related to R3. In order to use the slide deck, you must have: -- 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: +- **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 @@ -23,5 +23,7 @@ In order to use the slide deck, you must have: $ python contribute.py --date="YYYY-MM-DD" --name="yourAwesomeTitle" ``` -**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. +**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.