Skip to content

Commit dc7f2a9

Browse files
committed
Update README
1 parent 48ae510 commit dc7f2a9

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,24 @@ conda activate scipy_dev
1111
pip install -e .
1212
```
1313

14-
## Compiling the Presentation
14+
## Presentation
1515

16-
The presentation is compiled to HTML using [marp](https://marp.app/), which needs to be
16+
Our presentation is compiled to HTML using [marp](https://marp.app/), which needs to be
1717
installed and made available to the PATH. To get a PDF version that correctly displays
1818
pauses/breaks, we utilize [decktape](https://github.com/astefanutti/decktape).
1919

20+
### Installation of marp and decktape
21+
2022
To check that both executables are installed run
2123

2224
```bash
23-
pytask
25+
$ pytask src/scipy_dev/task_test_installations.py
2426
```
2527

26-
### Decktape
28+
**Installation:**
2729

28-
```bash
29-
$ decktape generic -s 1280x720 --load-pause 3000 file.html file.pdf
30-
```
30+
- marp: Can be installed from the [README instructions](https://github.com/marp-team/marp-cli)
31+
- decktape: Can be installed via ``npm install -g decktape``
3132

3233
## Credits
3334

0 commit comments

Comments
 (0)