Skip to content

Commit d9d5aba

Browse files
committed
Add README and LICENSE file
1 parent 8342659 commit d9d5aba

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

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: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# ipynb-quicklook
2+
3+
A Quick Look generator for
4+
[Jupyter](https://jupyter.org/)/[IPython](https://ipython.org/) notebooks
5+
without further dependencies. Contents are rendered on-the-fly using
6+
[nbviewer.js](https://github.com/kokes/nbviewer.js).
7+
8+
## Getting started
9+
10+
- Download `ipynb-quicklook.qlgenerator`
11+
- Move the generator into `/Library/QuickLook`. You may need to run `qlmanage
12+
-r` to reset the Quick Look server and caches.
13+
- Press <kbd>space</kbd> whenever you encounter a `.ipynb` file. Enjoy 👍
14+
15+
## Similar projects
16+
17+
- [jupyter-notebook-quick-look](https://github.com/jendas1/jupyter-notebook-quick-look):
18+
renders using the `nbconvert` utility.
19+
20+
## Acknowledgments
21+
22+
- Ondrej Kokes for [nbviewer.js](https://github.com/kokes/nbviewer.js)
23+
24+
## License
25+
26+
This project is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for
27+
details.
28+
29+
© 2017 [Tino Wagner](http://www.tinowagner.com/)

0 commit comments

Comments
 (0)