[pypy-svn] rev 2578 - pypy/trunk/doc/devel
pmaupin at codespeak.net
pmaupin at codespeak.net
Fri Dec 19 17:10:12 CET 2003
Author: pmaupin
Date: Fri Dec 19 17:10:11 2003
New Revision: 2578
Added:
pypy/trunk/doc/devel/howtopypy.txt (contents, props changed)
Modified:
pypy/trunk/doc/devel/ (props changed)
pypy/trunk/doc/devel/coding-style.txt (props changed)
pypy/trunk/doc/devel/howtosvn.txt (contents, props changed)
pypy/trunk/doc/devel/testdesign.txt (props changed)
Log:
Added howtopypy.txt
Added: pypy/trunk/doc/devel/howtopypy.txt
==============================================================================
--- (empty file)
+++ pypy/trunk/doc/devel/howtopypy.txt Fri Dec 19 17:10:11 2003
@@ -0,0 +1,91 @@
+==================================
+Getting started with PyPy
+==================================
+
+PyPy sources can be browsed on the web at:
+
+ ``http://codespeak.net/svn/pypy/trunk/``
+
+If you are ready to download and try PyPy out:
+
+1. Download subversion_ if you do not already have it
+
+2. Use subversion to download the source:
+
+ ``svn co http://codespeak.net/svn/pypy/trunk/src``
+
+ If desired, you can also download the documentation:
+
+ ``svn co http://codespeak.net/svn/pypy/trunk/doc``
+
+3. To start interpreting Python with PyPy:
+
+ ``cd src/pypy/interpreter``
+ ``python23 py.py -S``
+
+ After a few seconds, you should be at the PyPy prompt, which is
+ the same as the Python prompt, but with an extra ">".
+
+ The "-S" given on the command line insructs the PyPy interpreter
+ to use the Standard_ `object space`_. PyPy has the concept of different
+ object spaces, but the standard space is the one which contains
+ the "real" Python interpreter.
+
+4. Now you are ready to start running Python code. Some real Python
+ modules will not run yet, and others will run too slowly to be
+ worth waiting for, but a few are fun to run:
+
+ ``>>>> import pystone``
+ ``>>>> pystone.main(2)``
+
+ Note that this is a slightly modified version of pystone -- the
+ original version does not accept the parameter to main(). The
+ parameter is the number of loops to run through the test, and the
+ default is 50000, which is far too many to run this year.
+
+5. The PyPy interpreter command line options are listed by typing
+
+ ``python23 py.py --help``
+
+ As an example of using PyPy from the command line, you could type:
+
+ ``python23 py.py -S -c "import pystone; pystone.main(2)``
+
+ Alternatively, as with regular Python, you can simply give a
+ script name on the command line:
+
+ ``python23 py.py -S ../appspace/pystone.py``
+
+ (Note that this will run forever.)
+
+6. The PyPy project uses test-driven-development. Right now, there are
+ a couple of different categories of tests which can be run.
+ To run all the unit tests:
+
+ ``cd src/pypy``
+ ``python23 test_all.py -S``
+
+ Alternatively, subtests may be run by going to the correct subdirectory
+ and running them individually:
+
+ ``cd src/pypy/module/test``
+ ``python23 test_builtin.py -S``
+
+ Finally, there are some more advanced tests (which are derived from
+ some of the standard CPython tests). These are not part of the unit
+ tests, because they take longer than the standard unit tests.
+
+ ``cd src/pypy/interpreter``
+ ``python23 py.py -S -c "import builtin_types_test"``
+
+7. To learn more about PyPy and its development process, read the documentation_,
+ and consider subscribing to the `mailing lists`_ (or simply read the archives
+ online) or communicating via irc.freenode.net:6667, channel #pypy.
+
+--------------------------------------------------------------------------------
+
+.. _subversion: http://codespeak.net/pypy/index.cgi?doc/devel/howtosvn.html
+.. _Standard: http://codespeak.net/pypy/index.cgi?doc/objspace/stdobjspace.html
+.. _object space: http://codespeak.net/pypy/index.cgi?doc/objspace/objspace.html
+.. _mailing lists: http://codespeak.net/pypy/index.cgi?lists
+.. _documentation: http://codespeak.net/pypy/index.cgi?doc
\ No newline at end of file
Modified: pypy/trunk/doc/devel/howtosvn.txt
==============================================================================
--- pypy/trunk/doc/devel/howtosvn.txt (original)
+++ pypy/trunk/doc/devel/howtosvn.txt Fri Dec 19 17:10:11 2003
@@ -12,19 +12,19 @@
installation files which should help you to install subversion on
your computer.
-+ Unix source tarball_
++ Download_ Unix source tarball or prepackaged versions for MacOS, Windows, FreeBSD and Linux
-+ windows commandline_ utility
++ Additional information for Windows users:
- (See Microsoft website_ if you have .DLL issues.)
+ * See Microsoft website_ if you have .DLL issues.
-+ Windows Installer file for Tortoise SVN (like Tortoise CVS) GUI_
+ * Windows Installer file for Tortoise SVN (like Tortoise CVS) GUI_
- (See Win_ 2000, NT if you have problems loading it.)
+ (See Win_ 2000, NT if you have problems loading it.)
-+ MacOS_ X binary tar ball
++ Local copy of MacOS_ X binary tar ball
- this will also need iconv_ MacOS X tar ball
+ * this will also need iconv_ MacOS X tar ball
+ Debian instructions below...
@@ -127,7 +127,7 @@
.. _Win: http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=4B6140F9-2D36-4977-8FA1-6F8A0F5DCA8F
.. _MacOS: http://codespeak.net/~jum/svn-0.32.1-darwin-ppc.tar.gz
.. _iconv: http://codespeak.net/~jum/iconv-darwin-ppc.tar.gz
-.. _tarball: http://svn.collab.net/tarballs/subversion-0.34.0.tar.gz
+.. _Download: http://subversion.tigris.org/project_packages.html
.. _guide: http://svnbook.red-bean.com/book.html#svn-ch-1
.. _archives: http://codespeak.net/pipermail/pypy-svn/
More information about the Pypy-commit
mailing list