Commits

Robert Kern committed a934f06

DOC: more README in preparation for release.

Comments (0)

Files changed (1)

 standard library's cProfile or profile modules, depending on what is available.
 
 
+Installation
+============
+
+Source releases and any binaries can be downloaded from the PyPI link.
+
+    http://pypi.python.org/pypi/line_profiler
+
+To check out the development sources, you can use Mercurial_::
+
+    $ hg clone http://www.enthought.com/~rkern/cgi-bin/hgwebdir.cgi/line_profiler
+
+You may also download source tarballs of any snapshot from that URL.
+
+Source releases will require a C compiler in order to build line_profiler. In
+addition, Mercurial checkouts will also require Cython_. Source releases on PyPI
+should contain the pregenerated C sources, so Cython should not be required in
+that case.
+
+kernprof.py is a single-file pure Python script and does not require a compiler.
+If you wish to use it to run cProfile and not line-by-line profiling, you may
+copy it to a directory on your PATH manually and avoid trying to build any
+C extensions.
+
+In order to build and install line_profiler, you will simply use the standard
+`build and install`_ for most Python packages::
+
+    $ python setup.py install
+
+.. _Mercurial: http://www.selenic.com/mercurial/wiki/
+.. _Cython: http://www.cython.org
+.. _build and install: http://docs.python.org/install/index.html
+
+
 line_profiler
 =============
 
 
     You should not have to if you are building from a released source tarball.
     It should contain the generated C sources already. If you are running into
-    problems, that may be a bug; let me know. If you are building from an SVN
-    checkout, you will need Cython to generate the C sources. I'm not sure
-    exactly what version you need, but any recent one should suffice.
+    problems, that may be a bug; let me know. If you are building from
+    a Mercurial checkout or snapshot, you will need Cython to generate the
+    C sources. I'm not sure exactly what version you need, but any recent one
+    should suffice.
 
 * What version of Python do I need?
 
 
 
 To Do
------
+=====
 
 cProfile uses a neat "rotating trees" data structure to minimize the overhead of
 looking up and recording entries. LineProfiler uses Python dictionaries and
 
 
 Bugs and Such
--------------
+=============
 
 If you find a bug, or a missing feature you really want added, please post to
 the enthought-dev_ mailing list or email the author at
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.