Merge branch 'improve-readme' into 'develop'

Improve readme

See merge request R3-core/outreach/presentations-internal!39

README.md

@@ -8,7 +8,7 @@ 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.
 - **git-lfs**: Installation instructions are [here](https://help.github.com/en/articles/installing-git-large-file-storage)
-- **Python 3**: It is recommend to use a virtual environment
+- **Python 3**: It is recommend to use a virtual environment. Information on how to create a virtual environment is [here](https://virtualenvwrapper.readthedocs.io/en/latest/).
 - **yarn**: Instructions are [here](https://yarnpkg.com/lang/en/docs/install)
 
 ## How to get started
@@ -16,7 +16,7 @@ In order to use the slide deck, you must have:
 - Fork this repository
 - Clone your fork
     ```bash
-    $ git clone --recurse-submodules ssh://git@git-r3lab-server.uni.lu:8022/<yourUsername>/presentations.git
+    $ git clone --recurse-submodules ssh://git@git-r3lab-server.uni.lu:8022/<yourUsername>/presentations-internal.git
     ```
 - If the `--recurse-submodules` flag has been omitted, run this command to check for the missing modules and update them:
     ```bash
@@ -24,16 +24,26 @@ In order to use the slide deck, you must have:
     ```
 - Open a terminal and work on your presentation:
     ```bash
-    $ cd presentations
+    $ cd presentations-internal
     $ pip install .
     $ contribute --date="YYYY-MM-DD" --name="yourAwesomeTitle"
     ```
 
-<img src="https://webdav-r3lab.uni.lu/public/R3lab/logos/warning.png" height="20px" width="20px"> Please create a branch from `develop` before starting to work on your presentation. You could name it `YYYY-MM-DD_yourAwesomeTitle`.
+## <img src="https://webdav-r3lab.uni.lu/public/R3lab/logos/warning.png" height="20px" width="20px"> Tips
 
-If you are done with making changes to your presentation, push them to your fork and open a merge request against the `develop` branch.
+- Please create a branch from `develop` before starting to work on your presentation. You could name it `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.
+
+## <img src="https://webdav-r3lab.uni.lu/public/R3lab/logos/warning.png" height="20px" width="20px">Solving the error: `Fatal error: Unable to find local grunt.`
+
+If you get a fatal error complaining about your local grunt installation, please make sure that you have add the `--recurse-submodules` flag when cloning, or that you ran the `git submodule update --init --recursive` command from within
+the `presentations-internal` directory.
+
+Please also make sure that you run the `contribute` command from the root of the `presentations-internal` directory.
+
+
+## How to continue working on a presentation
 
-## How to continue
  For resuming your work on a presentation, you can either run the same contribute command:</br>
  ```
  $ contribute --date="YYYY-MM-DD" --name="yourAwesomeTitle"
@@ -46,13 +56,14 @@ If you are done with making changes to your presentation, push them to your fork
  ```
 
 ## Adding a new slide/slides
+
  Create a Markdown file with your slide(s) in `YYYY-MM-DD_yourAwesomeTitle/slides` and place it into `list.md` file at desired position:
 
 ```
- [
-    {"filename": "index.md","attr": {}},
-    {"filename": "structure.md","attr": {}},
-    {"filename": "myNewAwesomeSlide.md","attr": {}},
-    {"filename": "thanks.md","attr": {}}
+[
+    { "filename": "index.md" },
+    { "filename": "structure.md" },
+    { "filename": "myNewAwesomeSlide.md" },
+    { "filename": "thanks.md" }
 ]
 ```