Skip to content

Commit

Permalink
Small documentation updates and comments about Windows install.
Browse files Browse the repository at this point in the history
  • Loading branch information
fperez committed Aug 2, 2009
1 parent 0124345 commit 0b15f36
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 8 deletions.
7 changes: 6 additions & 1 deletion docs/source/config/initial_config.txt
Expand Up @@ -175,11 +175,16 @@ In order to configure less as your default pager, do the following:
properly interpret control sequences, which is how color
information is given to your terminal.

For the bash shell, add to your ~/.bashrc file the lines::

export PAGER=less
export LESS=-r

For the csh or tcsh shells, add to your ~/.cshrc file the lines::

setenv PAGER less
setenv LESS -r

There is similar syntax for other Unix shells, look at your system
documentation for details.

Expand Down
26 changes: 19 additions & 7 deletions docs/source/install/install.txt
Expand Up @@ -9,14 +9,16 @@ install all of its dependencies.


Please let us know if you have problems installing IPython or any of its
dependencies. IPython requires Python version 2.4 or greater. Light testing
has been done on version 2.6, and so far everything looks fine. We have *not*
yet started to port IPython to Python 3.0, where the language changes are much
more significant.
dependencies. Officially, IPython requires Python version 2.5 or 2.6. We
have *not* yet started to port IPython to Python 3.0.

.. warning::

IPython will not work with Python 2.4 or below.
Officially, IPython supports Python versions 2.5 and 2.6.

IPython 0.10 has only been well tested with Python 2.5 and 2.6. Parts of
it may work with Python 2.4, but we do not officially support Python 2.4
anymore. If you need to use 2.4, you can still run IPython 0.9.

Some of the installation approaches use the :mod:`setuptools` package and its
:command:`easy_install` command line program. In many scenarios, this provides
Expand Down Expand Up @@ -85,8 +87,8 @@ Windows

There are a few caveats for Windows users. The main issue is that a basic
``python setup.py install`` approach won't create ``.bat`` file or Start Menu
shortcuts, which most users want. To get an installation with these, there are
two choices:
shortcuts, which most users want. To get an installation with these, you can
use any of the following alternatives:

1. Install using :command:`easy_install`.

Expand All @@ -96,6 +98,16 @@ two choices:
3. Install from source, but using :mod:`setuptools` (``python setupegg.py
install``).

IPython by default runs in a termninal window, but the normal terminal
application supplied by Microsoft Windows is very primitive. You may want to
download the excellent and free Console_ application instead, which is a far
superior tool. You can even configure Console to give you by default an
IPython tab, which is very convenient to create new IPython sessions directly
from the working terminal.

.. _Console: http://sourceforge.net/projects/console


Installing the development version
----------------------------------

Expand Down

0 comments on commit 0b15f36

Please sign in to comment.