Skip to content

Commit 6a64e57

Browse files
committed
Add readmes and license
1 parent 9e44501 commit 6a64e57

File tree

5 files changed

+102
-3
lines changed

5 files changed

+102
-3
lines changed

Jupyter Notebook Viewer/Credits.rtf

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,19 @@
77

88
\f0\b\fs24 \cf0 Website
99
\b0 \
10-
{\field{\*\fldinst{HYPERLINK "https://github.com/tuxu/jupyter-notebook-quicklook/"}}{\fldrslt https://github.com/tuxu/jupyter-notebook-quicklook/}}\
10+
\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\qc\partightenfactor0
11+
{\field{\*\fldinst{HYPERLINK "https://github.com/tuxu/nbviewer-app/"}}{\fldrslt \cf0 https://github.com/tuxu/nbviewer-app/}}\
1112
\
13+
\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\qc\partightenfactor0
1214

13-
\b Project Jupyter
15+
\b \cf0 Project Jupyter
1416
\b0 \
1517
\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\qc\partightenfactor0
1618
{\field{\*\fldinst{HYPERLINK "http://jupyter.org/"}}{\fldrslt \cf0 https://jupyter.org/}}\
1719
\
20+
\pard\tx566\tx1133\tx1700\tx2267\tx2834\tx3401\tx3968\tx4535\tx5102\tx5669\tx6236\tx6803\pardirnatural\qc\partightenfactor0
1821

19-
\b With special thanks
22+
\b \cf0 With special thanks
2023
\b0 \
2124
Ondrej Kokes for {\field{\*\fldinst{HYPERLINK "https://github.com/kokes/nbviewer.js"}}{\fldrslt nbviewer.js}}\
2225
\

LICENSE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright © 2017 Tino Wagner
5+
6+
Permission is hereby granted, free of charge, to any person
7+
obtaining a copy of this software and associated documentation
8+
files (the “Software”), to deal in the Software without
9+
restriction, including without limitation the rights to use,
10+
copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the
12+
Software is furnished to do so, subject to the following
13+
conditions:
14+
15+
The above copyright notice and this permission notice shall be
16+
included in all copies or substantial portions of the Software.
17+
18+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
19+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20+
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22+
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25+
OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Jupyter Notebook Viewer
2+
3+
![Icon](Jupyter Notebook Viewer/Images.xcassets/AppIcon.appiconset/icon_256x256.png)
4+
5+
A native macOS application to view
6+
[Jupyter](https://jupyter.org/)/[IPython](https://ipython.org/) notebooks.
7+
8+
## Features
9+
10+
- Stand-alone, thanks to [nbviewer.js](https://github.com/kokes/nbviewer.js)
11+
- Integrated [Quick Look generator](https://github.com/tuxu/ipynb-quicklook/)
12+
- Nice icons 😎
13+
14+
## Getting started
15+
16+
- Download `nbviewer-app.zip`
17+
([Releases](https://github.com/tuxu/nbviewer-app/releases))
18+
- Unzip and move `Jupyter Notebook Viewer.app` to `/Applications` and enjoy 👍
19+
- Quick Look should work out of the box. If it doesn't, check
20+
`qlmanage -m plugins | grep ipynb` to see whether the plugin appears there.
21+
22+
## Screenshot
23+
24+
![Screenshot](screenshot.png)
25+
26+
## Acknowledgments
27+
28+
- Ondrej Kokes for [nbviewer.js](https://github.com/kokes/nbviewer.js)
29+
30+
## License
31+
32+
This project is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for
33+
details.
34+
35+
© 2017 [Tino Wagner](http://www.tinowagner.com/)

icons/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Icons
2+
3+
The icons are based on the [Jupyter logos](https://github.com/jupyter/design/tree/master/logos)
4+
found in the [brand guide](https://github.com/jupyter/design/raw/master/brandguide/jupyter_brand_guide.pdf).
5+
6+
# License
7+
8+
## Project Jupyter logo
9+
10+
Copyright (c) 2014, Project Jupyter
11+
All rights reserved.
12+
13+
Redistribution and use in source and binary forms, with or without
14+
modification, are permitted provided that the following conditions are met:
15+
16+
* Redistributions of source code must retain the above copyright notice, this
17+
list of conditions and the following disclaimer.
18+
19+
* Redistributions in binary form must reproduce the above copyright notice,
20+
this list of conditions and the following disclaimer in the documentation
21+
and/or other materials provided with the distribution.
22+
23+
* Neither the name of the {organization} nor the names of its
24+
contributors may be used to endorse or promote products derived from
25+
this software without specific prior written permission.
26+
27+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
30+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
31+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
33+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
34+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
35+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

screenshot.png

354 KB
Loading

0 commit comments

Comments
 (0)