From 6d7dace00e3c34a8ec0277cb620bebcf9a55fd65 Mon Sep 17 00:00:00 2001 From: Keith Date: Fri, 26 May 2017 17:13:02 -0600 Subject: [PATCH] updated readme formatting --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4ab4427..26efb53 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The original talk was presented on April 21, 2017 by me (myself and I) to the [C ## Installing the talk -This talk was originally written as a Jupyter notebook and the HTML file for the talk is using [reveal.js](). +This talk was originally written as a Jupyter notebook and the HTML file for the talk is using [reveal.js](http://lab.hakim.se/reveal-js/#/). To convert the talk to HTML you will need to run: ``` @@ -24,26 +24,22 @@ jupyter nbconvert nbextensions_talk.ipynb --to slides --reveal-prefix "http://cd While the source for the talk is provided here, you do not need to convert it unless you need to make modifications to it. -To view the talk, simply clone this repository and view the original HTML source in any browser here: +To view the talk, _simply clone this repository_ and _view the original HTML source in any browser_ in the -[Original source HTML](./slides.slides.html) +* [original source HTML in `nbextensions_talk.slides.html`](./nbextensions_talk.slides.html) ready to be viewed. -The example file that shows a few of these extensions at work can be found in the notebook: +An example file that shows a few of these extensions at work can be found in the -[Example notebook showing extensions at work](./example_document.ipynb) - -OR as HTML - -[HTML-converted example notebook showing extensions at work](./example_document.html) +* [notebook in `example_document.ipynb`](./example_document.ipynb) or +* [as HTML in `example_document.html`](./example_document.html) ## Resources -Installing NBExtensions can be found here: +To understand the full installation requirement for NBExtensions explore here: [https://github.com/ipython-contrib/jupyter_contrib_nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions) -And the convenience of installing the plugin configurator can be found here: +And if you'd like the convenience of installing the plugin configurator, that can be found here: [https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator](https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator) -The complete instructions and project documentation should be consulted to install properly. - +The complete instructions and project documentation **should be consulted to install and use properly to fullest extent**. \ No newline at end of file