[pypy-svn] r8385 - pypy/dist/pypy/documentation

[hpk at codespeak.net]

Author: hpk
Date: Tue Jan 18 16:11:27 2005
New Revision: 8385

Modified:
   pypy/dist/pypy/documentation/readme.txt
Log:
added information about source code to readme (what
is currently the "source" menu entry 



Modified: pypy/dist/pypy/documentation/readme.txt
==============================================================================
--- pypy/dist/pypy/documentation/readme.txt	(original)
+++ pypy/dist/pypy/documentation/readme.txt	Tue Jan 18 16:11:27 2005
@@ -1,14 +1,84 @@
-=====================
+PyPy Source Code 
+================ 
+
+.. contents::
+.. sectnum::
+
+Checking out & running PyPy as a two-liner 
+------------------------------------------ 
+
+There is no public release yet, but you can easily 
+
+
+    svn co http://codespeak.net/svn/pypy/dist dist-pypy 
+
+After checkout you should be able to get a PyPy interpreter via:: 
+
+    python dist-pypy/pypy/interpreter/py.py 
+
+have fun :-) 
+
+
+Browsing via HTTP and getting an svn client
+-------------------------------------------
+
+You can `browse the pypy source code`_ directly via http.
+(sorry, viewcvs is still not stable enough with subversion).
+And here is some information to `install a subversion client`_. 
+
+.. _`install a subversion client`: howtosvn.html 
+.. _`browse the pypy source code`: http://codespeak.net/svn/pypy/dist 
+
+
+coding style and testing 
+------------------------ 
+
+We keep a strong focus on testing because we want to be able
+to refactor things all the time (without proper automated 
+testing this would become very hard and fragile).  
+
+For an overview of how we organize our codebase please look at our 
+`coding-style document`_.   
+
+For running all PyPy tests you can issue:: 
+
+    cd dist-pypy/pypy/
+    python test_all.py 
+
+test_all.py really is another name for `py.test`_ which is a testing
+tool working from the current directory unless you specify 
+filename/directory arguments. 
+
+If you want to have write access to the codespeak respository
+please send a mail to <b>jum at anubis han de</b> or <b>hpk at merlinux de</b>
+in order to ask for a username and password.  Please mention what you want to do
+within the pypy project. Even better, come to our next sprint so that we can get
+to know you.  
+
+.. _`documentation start page`: http://codespeak.net/pypy/index.cgi?doc/index.html 
+.. _`coding-style document`: http://codespeak.net/pypy/index.cgi?doc/devel/coding-style.html 
+.. _`py.test`: /py/current/doc/test.html 
+
+
 PyPy Documentation
-=====================
+==================
+
 
-PyPy documentation is generated from reST textfiles in the /doc directory of
-our pypy-subversion repository.  On the pypy home page you'll find a "doc" link that
-shows you a list of recently modified documents.  While in "doc-view" you also have
-a navigation area on the left side which maps all documentation. 
+Viewing documentation 
+---------------------
+
+PyPy documentation is generated from reST textfiles in the pypy/documentation directory of
+our pypy-subversion repository.  Go to the `documentation start page`_ and hit
+"recently modified" to get a list of recently modified documents.  While in 
+"doc-view" you also have a navigation area on the left side which maps all 
+documentation files. 
+
+Adding documentation 
+-------------------- 
 
 Please add new or updated documentation by checking it in to the appropriate 
-directory in subversion, usually under http://codespeak.net/svn/pypy/trunk/doc/.  
+directory in subversion, usually under 
+http://codespeak.net/svn/pypy/dist/pypy/documentation 
 
 + Remember to run ``svn up`` **before** doing any commit.
 + All filenames should be lowercase, and documentation should be .txt files.
@@ -19,7 +89,7 @@
 runs the parser, it'll look ugly on the website. So run docutils yourself before you commit it. 
 
 Some reST basics:
-------------------
+-----------------
 
 There should be a title on your page. Do it like this::
 
@@ -48,7 +118,6 @@
 
 You can get more info on reST markup at http://docutils.sourceforge.net/docs/rst/quickref.html
 
-------------------------
 Checking your work
 ------------------------