README.md 1.74 KB
Newer Older
Laurent Heirendt's avatar
Laurent Heirendt committed
1
# Presentation slides
Laurent Heirendt's avatar
Laurent Heirendt committed
2

Laurent Heirendt's avatar
Laurent Heirendt committed
3
4
This repository contains all presentations related to R3.

Laurent Heirendt's avatar
Laurent Heirendt committed
5
6
# Preferred method

Laurent Heirendt's avatar
Laurent Heirendt committed
7
<img src="https://webdav-r3lab.uni.lu/public/R3lab/logos/warning.png" height="20px" width="20px"> Install Docker first: https://docs.docker.com/install/
Laurent Heirendt's avatar
Laurent Heirendt committed
8

9
10
11
12
13
<img src="https://webdav-r3lab.uni.lu/public/R3lab/logos/warning.png" height="20px" width="20px"> Please clone using the following command:
```bash
$ git clone --recurse-submodules ssh://git@git-r3lab-server.uni.lu:8022/R3/outreach/templates/presentation.git
```

Laurent Heirendt's avatar
Laurent Heirendt committed
14
15
Then, run:

Laurent Heirendt's avatar
Laurent Heirendt committed
16
```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
17
18
19
$ ./contribute.sh -d YYYY-MM-DD -n presentationName
```
Your slides are now in `YYYY/YYYY-MM-DD_presentationName/slides`.
Laurent Heirendt's avatar
Laurent Heirendt committed
20
21
22
23
24
The first time, the underlying docker image will be downloaded (pulled). This may take a while.

Once the slides have been compiled, a local server is running under http://localhost:9000. You may need to access this server under http://127.0.0.1:9000 or http://0.0.0.0:9000.

In order to stop the execution, hit `CTRL+C`. Rerun the same command above to continue working on the presentation.
Laurent Heirendt's avatar
Laurent Heirendt committed
25
26
27
28
29
30
31

**Example** for a Xmas presentation:
```bash
$ ./contribute.sh -d 2019-12-25 -n xmas
```
The slides are in `2019/2019-12-25_xmas/slides`.

Laurent Heirendt's avatar
Laurent Heirendt committed
32
33
## Adding a new slide/slides

Laurent Heirendt's avatar
Laurent Heirendt committed
34
Create a JSON file with your slide(s) in `YYYY-MM-DD_presentationName/slides` and place it into `list.json` file at desired position:
Laurent Heirendt's avatar
Laurent Heirendt committed
35
36
37
38
39
40
41
42
```
[
    { "filename": "index.md" },
    { "filename": "structure.md" },
    { "filename": "myNewAwesomeSlide.md" },
    { "filename": "thanks.md" }
]
```
Laurent Heirendt's avatar
Laurent Heirendt committed
43
44
45
46
47
48

## How to continue working on a presentation

 For resuming your work on a presentation, you can run the same contribute command:</br>
 ```bash
 $ ./contribute.sh -d YYYY-MM-DD -n presentationName
Laurent Heirendt's avatar
Laurent Heirendt committed
49
50
51
52
53
 ```

## Further information

More information is in the `docs` folder.