From 93d5d2edd0b5b81c3a11c5967845bd9c745685f7 2016-07-01 23:24:12 From: Matthias Bussonnier Date: 2016-07-01 23:24:12 Subject: [PATCH] Update readme instructions. --- diff --git a/README.rst b/README.rst index 9da53f0..6911d8c 100644 --- a/README.rst +++ b/README.rst @@ -18,28 +18,30 @@ Overview ======== -Welcome to IPython. Our full documentation is available on `our website -`_; if you downloaded a built source -distribution the ``docs/source`` directory contains the plaintext version of -these manuals. If you have Sphinx installed, you can build them by typing -``cd docs; make html`` for local browsing. +Welcome to IPython. Our full documentation is available on `ipython.readthedocs.io +`_ and contain information on how to install, use +contribute to the project. - -See the `install page `__ to install IPython. +Officially, IPython requires Python version 2.7, or 3.3 and above. +IPython 1.x is the last IPython version to support Python 2.6 and 3.2. The Notebook, Qt console and a number of other pieces are now parts of *Jupyter*. See the `Jupyter installation docs `__ if you want to use these. -Officially, IPython requires Python version 2.7, or 3.3 and above. -IPython 1.x is the last IPython version to support Python 2.6 and 3.2. -Instant running -=============== + +Developement and Instant runnimg +================================ + +You can find the latest version of the development documentation on `readthedocs +`_. You can run IPython from this directory without even installing it system-wide by typing at the terminal:: - + $ python -m IPython +Documentation and installation instructions for older version of IPython can be found on the +`IPython website `_