Changeset 4978

Timestamp:

1 Feb 2010, 22:11:30 (15 years ago)

Author:

uli

Message:

Fix package names and svn download path.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/doc/developernotes.txt (modified) (8 diffs)

main/waeup.sirp/trunk/src/waeup/sirp/doc/developernotes.txt

@@ -2 +2 @@
 ***************
 
-How to setup a developer instance of the WAeUP SRP, handle tests, docs
+How to setup a developer instance of the WAeUP SIRP, handle tests, docs
 etc.
 
-The new WAeUP SRP is based on `Grok <http://grok.zope.org/>`_.
+The new WAeUP SIRP is based on `Grok <http://grok.zope.org/>`_.
 
 Installing a developer copy
@@ -15 +15 @@
 --------------------
 
-To create a working copy of the WAeUP SRP we recommend use of
+To create a working copy of the WAeUP SIRP we recommend use of
 `virtualenv`. You, however, need also some basic libraries, a C
 compiler and some things more.
@@ -127 +127 @@
 In the sandbox (or anywhere else) we now create our real working
 environment. To do this, we change to the sandbox and checkout the
-sources of the WAeUP SRP from the subversion server::
+sources of the WAeUP SIRP from the subversion server::
 
   $ cd mysandbox/
-  $ svn co https://svn.waeup.org/repos/waeup/tunk waeup-trunk
+  $ svn co https://svn.waeup.org/repos/main/waeup.sirp/trunk waeup-trunk
 
 where ``waeup-trunk`` is only a name we've chosen here to make clear
@@ -194 +194 @@
 =============
 
-With the :mod:`waeup` package we try to reach high standards in both,
-documentation and testing.
-
-:mod:`waeup` makes extensive use of doctests, which this way also
+With the :mod:`waeup.sirp` package we try to reach high standards in
+both, documentation and testing.
+
+:mod:`waeup.sirp` makes extensive use of doctests, which this way also
 become both: executable (i.e. testable) examples and documentation.
 
@@ -206 +206 @@
 documentation generator to generate the docs as HTML pages.
 
-The documentation of the :mod:`waeup` project can easily be created
-doing::
+The documentation of the :mod:`waeup.sirp` project can easily be
+created doing::
 
   $ bin/waeupdocs
 
 This will create a tree of HTML pages in
-``parts/waeupdocs/waeup/build/waeup/`` which you can for instance
-browse by pointing your browser to this location.
+``parts/waeupdocs/waeup.sirp/build/waeup.sirp/`` which you can for
+instance browse by pointing your browser to this location.
 
 An 'official' place in internet for the whole docs is about to come
@@ -223 +223 @@
 
 means explaining to other developers what your code does and test it
-at the same time. See the many .txt files in the :mod:`waeup` package
-for examples.
+at the same time. See the many .txt files in the :mod:`waeup.sirp`
+package for examples.
 
 
@@ -230 +230 @@
 =======
 
-Tests are most important to the reliability of the :mod:`waeup`
+Tests are most important to the reliability of the :mod:`waeup.sirp`
 package. We don't tell someone that our code works, if we cannot prove
 it. And we prove it by testing.
@@ -246 +246 @@
   $ bin/test -c
 
-We have many tests in the :mod:`waeup` package so that sometimes you
-only want the functional *or* the unit tests to run. This can be done
-like this::
+We have many tests in the :mod:`waeup.sirp` package so that sometimes
+you only want the functional *or* the unit tests to run. This can be
+done like this::
 
   $ bin/test -c -u