-
-
Notifications
You must be signed in to change notification settings - Fork 415
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
reverse direction of symlinks for README.md and LICENSE.md i.e. leave plain files in classic/ and create a symlink from the top otherwise when running pip install classic/ then README.md as captured by the packaging tools is nothing but a stale symlink
- Loading branch information
1 parent
ea7387d
commit dc8974b
Showing
4 changed files
with
74 additions
and
74 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
classic/LICENSE.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
classic/README.md |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Copyright (c) 2013-2016, Damián Avila and contributors | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# 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. | ||
|
||
## Support us | ||
|
||
Please visit this page for more information: https://rise.readthedocs.io/en/stable/support.html |