From 062438bc23d816023b76f2f18801b6c1b02b3cc7 Mon Sep 17 00:00:00 2001 From: Roger Labbe Date: Wed, 31 Jan 2018 05:27:04 -0800 Subject: [PATCH] Added caveat about GitHub GitHub does not render the math well, so I warn people off from using it to read the book. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ef8dfb..24bdc7c 100644 --- a/README.md +++ b/README.md @@ -74,9 +74,12 @@ binder serves interactive notebooks online, so you can run the code and change t The website http://nbviewer.org provides an Jupyter Notebook server that renders notebooks stored at github (or elsewhere). The rendering is done in real time when you load the book. You may use [*this nbviewer link*](http://nbviewer.ipython.org/github/rlabbe/Kalman-and-Bayesian-Filters-in-Python/blob/master/table_of_contents.ipynb) to access my book via nbviewer. If you read my book today, and then I make a change tomorrow, when you go back tomorrow you will see that change. Notebooks are rendered statically - you can read them, but not modify or run the code. +nbviewer seems to lag the checked in version by a few days, so you might not be reading the most recent content. + + ### GitHub -GitHub is able to render the notebooks directly. The quickest way to view a notebook is to just click on them above. Note: I have found this to be buggy - sometimes it cannot open files that are readable by all the other methods here. Chapters names are prefaced with numbers to indicate their order 01_gh_filter.ipynb, and so on. Notebooks are rendered statically - you can read them, but not modify or run the code. +GitHub is able to render the notebooks directly. The quickest way to view a notebook is to just click on them above. However, it renders the math incorrectly, and I cannot recommend using it if you are doing more than just dipping into the book. PDF Version