# RISE

RISE allows you to instantly turn your Jupyter Notebooks into a
slideshow. No out-of-band conversion is needed, switch from jupyter
notebook to a live *reveal.js*-based slideshow in a single keystroke,
and back.

![Basic usage](https://media.giphy.com/media/3oxHQtTxAaZwMOHr9u/giphy.gif)

## Resources

RISE stands for ***Reveal.js - Jupyter/IPython Slideshow Extension***:

* Demo notebook (no installation required)
  * [![](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/damianavila/RISE/master?filepath=examples%2FREADME.ipynb)

* Source code is on github <https://github.com/damianavila/RISE>
  * [![Issues](http://img.shields.io/github/issues/damianavila/RISE.svg)](https://github.com/damianavila/RISE/issues)

* Documentation is hosted on readthedocs
  * [![doc status](https://readthedocs.org/projects/rise/badge)](http://rise.readthedocs.io/)

* Chat room on gitter
  * [![Gitter chat](https://badges.gitter.im/damianavila/RISE.png)](https://gitter.im/damianavila/RISE)

* Videos on youtube
  * basic usage (4'30'')

    <https://youtu.be/sXyFa_r1nxA>


## Installation

You essentially have 2 options:

### Option 1 - Using conda:

```
conda install -c conda-forge rise
```

### Option 2 - Using pip:

```
pip install RISE
```

## Development

To install RISE in development mode, see the
[Developer section](https://rise.readthedocs.io/en/stable/dev/index.html) of the RISE
documentation.

## Feedback

If you have any feedback, or find any bugs, please let us know just opening an issue.
