[pypy-svn] r4768 - pypy/trunk/doc

[anna at codespeak.net]

Author: anna
Date: Mon May 31 17:45:26 2004
New Revision: 4768

Modified:
   pypy/trunk/doc/index.txt
Log:
pypy documentation page, first draft

Modified: pypy/trunk/doc/index.txt
==============================================================================
--- pypy/trunk/doc/index.txt	(original)
+++ pypy/trunk/doc/index.txt	Mon May 31 17:45:26 2004
@@ -1,4 +1,41 @@
 Pypy Documentation Tree
 =======================
 
-No contents available yet.
\ No newline at end of file
+We have a fair amount of documentation for the Pypy project. The files are available from the website as html (view them along the left side of the pypy doc web-page). They are also available from the repository, under the doc/ directory or under the src/devel directory. 
+
+If you just want an overview of the project, take a look at our presentation to OSCON:
+ 
+ * doc/oscon2003-paper::
+	presentation to OSCON on what pypy is about and why you should care
+
+If you are wanting to get involved, take a look at the following documentation to get a better taste:
+
+ * doc/howtopypy::
+	provides some hands-on instructions for getting started
+
+ * doc/readme::
+	this file is on using ReST for pypy documentation
+
+ * doc/architecture::
+	an overview of the current architecture 
+
+ * doc/wrapping::
+	a description of application-level and interpreter-level wrapped 	objects
+
+Before doing pypy work, you should also take a look at these developer-specific instructions:
+
+ * devel/coding-style::
+	covers pypy coding conventions
+
+ * devel/howtosvn::
+	for new users of subversion
+
+ * checking_ReST::
+	if you are adding documentation, look at both the doc/readme 		mentioned above and this file: 		
+
+ * optionaltool::
+	there are some optional tools we use for pypy. 
+
+ * testdesign::
+	pypy is a test-driven development project.read here to find out more 	about how we're doing testing.
+	
\ No newline at end of file