Skip to content

Commit dc8974b

Browse files
committed
fix broken packaging
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
1 parent ea7387d commit dc8974b

File tree

4 files changed

+74
-74
lines changed

4 files changed

+74
-74
lines changed

LICENSE.md

-12
This file was deleted.

LICENSE.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
classic/LICENSE.md

README.md

-60
This file was deleted.

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
classic/README.md

classic/LICENSE.md

-1
This file was deleted.

classic/LICENSE.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright (c) 2013-2016, Damián Avila and contributors
2+
All rights reserved.
3+
4+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+
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.
9+
10+
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.
11+
12+
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.

classic/README.md

-1
This file was deleted.

classic/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# RISE
2+
3+
RISE allows you to instantly turn your Jupyter Notebooks into a
4+
slideshow. No out-of-band conversion is needed, switch from jupyter
5+
notebook to a live *reveal.js*-based slideshow in a single keystroke,
6+
and back.
7+
8+
![Basic usage](https://media.giphy.com/media/3oxHQtTxAaZwMOHr9u/giphy.gif)
9+
10+
## Resources
11+
12+
RISE stands for ***Reveal.js - Jupyter/IPython Slideshow Extension***:
13+
14+
* Demo notebook (no installation required)
15+
* [![](https://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/damianavila/RISE/master?filepath=examples%2FREADME.ipynb)
16+
17+
* Source code is on github <https://github.com/damianavila/RISE>
18+
* [![Issues](http://img.shields.io/github/issues/damianavila/RISE.svg)](https://github.com/damianavila/RISE/issues)
19+
20+
* Documentation is hosted on readthedocs
21+
* [![doc status](https://readthedocs.org/projects/rise/badge)](http://rise.readthedocs.io/)
22+
23+
* Chat room on gitter
24+
* [![Gitter chat](https://badges.gitter.im/damianavila/RISE.png)](https://gitter.im/damianavila/RISE)
25+
26+
* Videos on youtube
27+
* basic usage (4'30'')
28+
29+
<https://youtu.be/sXyFa_r1nxA>
30+
31+
32+
## Installation
33+
34+
You essentially have 2 options:
35+
36+
### Option 1 - Using conda:
37+
38+
```
39+
conda install -c conda-forge rise
40+
```
41+
42+
### Option 2 - Using pip:
43+
44+
```
45+
pip install RISE
46+
```
47+
48+
## Development
49+
50+
To install RISE in development mode, see the
51+
[Developer section](https://rise.readthedocs.io/en/stable/dev/index.html) of the RISE
52+
documentation.
53+
54+
## Feedback
55+
56+
If you have any feedback, or find any bugs, please let us know just opening an issue.
57+
58+
## Support us
59+
60+
Please visit this page for more information: https://rise.readthedocs.io/en/stable/support.html

0 commit comments

Comments
 (0)