##// END OF EJS Templates
Minor doc updates, ensure README is in final tarball.
Fernando Perez -
Show More
@@ -1,36 +1,37 b''
1 include README.rst
1 2 include ipython.py
2 3 include setup2.py
3 4 include setup3.py
4 5 include setupbase.py
5 6 include setupegg.py
6 7
7 8 graft setupext
8 9
9 10 graft scripts
10 11
11 12 # Load main dir but exclude things we don't want in the distro
12 13 graft IPython
13 14 prune IPython/deathrow
14 15 prune IPython/frontend/html/notebook/static/mathjax
15 16
16 17 # Include some specific files and data resources we need
17 18 include IPython/.git_commit_info.ini
18 19 include IPython/frontend/qt/console/resources/icon/IPythonConsole.svg
19 20
20 21 # Documentation
21 22 graft docs
22 23 exclude docs/\#*
23 24 exclude docs/man/*.1
24 25
25 26 # docs subdirs we want to skip
26 27 prune docs/attic
27 28 prune docs/build
28 29 prune docs/gh-pages
29 30 prune docs/dist
30 31
31 32 # Patterns to exclude from any directory
32 33 global-exclude *~
33 34 global-exclude *.flc
34 35 global-exclude *.pyc
35 36 global-exclude *.pyo
36 37 global-exclude .dircopy.log
@@ -1,31 +1,31 b''
1 1 ===========================================
2 2 IPython: Productive Interactive Computing
3 3 ===========================================
4 4
5 5 Overview
6 6 ========
7 7
8 Welcome to IPython. Our full documentation, including PDF versions of our
9 manual, is available on `our website <http://ipython.org/documentation.html>`_;
10 if you downloaded a built source distribution the ``docs/html`` directory
11 contains an HTML version of the manual. The ``docs/source`` directory contains
12 the plaintext version of these manuals.
8 Welcome to IPython. Our full documentation is available on `our website
9 <http://ipython.org/documentation.html>`_; if you downloaded a built source
10 distribution the ``docs/source`` directory contains the plaintext version of
11 these manuals. If you have Sphinx installed, you can build them by typing
12 ``make html`` for local browsing.
13 13
14 14
15 15 Dependencies and supported Python versions
16 16 ==========================================
17 17
18 18 For full details, see the installation section of the manual. The basic parts
19 19 of IPython only need the Python standard library, but much of its more advanced
20 20 functionality requires extra packages.
21 21
22 22 Officially, IPython requires Python version 2.6, 2.7, or 3.1 and above.
23 23
24 24
25 25 Instant running
26 26 ===============
27 27
28 28 You can run IPython from this directory without even installing it system-wide
29 29 by typing at the terminal::
30 30
31 31 $ python ipython.py
General Comments 0
You need to be logged in to leave comments. Login now