Skip to content
Snippets Groups Projects
Commit d068f5bb authored by Laurent Heirendt's avatar Laurent Heirendt :airplane:
Browse files

improve readme file with installation instructions and tips

parent f4286d26
No related branches found
No related tags found
No related merge requests found
......@@ -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">`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" }
]
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment