Changeset 11404 for main/waeup.aaua

Timestamp:

24 Feb 2014, 10:24:45 (11 years ago)

Author:

uli

Message:

Update test and build section of part 1.

File:

• main/waeup.aaua/trunk/INSTALL.txt (modified) (4 diffs)

main/waeup.aaua/trunk/INSTALL.txt

@@ -206 +206 @@
 
 
-Preparing the build
-===================
-
-In the sources directory (``kofa-trunk/``) you have to prepare the
+Building the Package
+====================
+
+In the sources directory (``trunk/``) you have to prepare the
 project to fetch needed components (eggs), compile C-code parts,
-etc. This steip will not touch any external projects::
-
-  (py27)$ python bootstrap.py
-
-This will generate some directories and the ``buildout`` script in
-``bin/`` for us. This step must be executed only once for each
-instance.
-
-You can now deactivate the sandbox::
-
-  (py27)$ deactivate
-
-Now we can do the real build by triggering::
-
-  $ bin/buildout
+etc. This is done by a single command ``buildout``::
+
+  $ ./bin/buildout
 
 If this is your first install of some Grok-related project, this step
@@ -232 +220 @@
 
 This step must be redone whenever you change something in
-``buildout.cfg`` or ``setup.py``.
+``buildout.cfg``, ``buildout-zeo.cfg``, or ``setup.py``.
 
 Note that if you have more than one sandbox for a Zope-based web
@@ -243 +231 @@
   eggs-directory = /home/bruno/buildout-eggs
 
-
-Start the instance
+where the given directory should be exist beforehand. All eggs of all
+`buildout` projects will then be stored in this directory (and not
+fetched anew if already existing there).
+
+
+Start the Instance
 ==================
 
 You should be able now to start the created instance by doing::
 
-  $ bin/zopectl fg
+  $ ./bin/kofactl fg
 
 Alternatively you can do::
 
-  $ bin/paster serve parts/etc/deploy.ini
+  $ bin/paster serve parts/etc/deploy-themed.ini
 
 The port numbers where Kofa is running on your server are defined in
-buildout.cfg under [kofa_params].
-
-If you now point a browser to the right port on your server, for example ::
+`buildout.cfg` under ``[kofa_params]``.
+
+If you now point a browser to the right port on your server, for example::
 
   localhost:8080
@@ -274 +266 @@
 then visible entry in the list of installed applications.
 
-Running the tests
+Running the Tests
 =================
 
-The tests are easily run by executing the test runner that's
-installed in the ``bin`` directory::
-
-  $ bin/test
+All WAeUP_ packages come with comprehensive test suites ensuring the
+software quality also after changes and updates.
+
+The package tests are easily run by executing the test runner
+from the ``bin`` directory::
+
+  $ ./bin/test
+
+Use the ``-c`` option to get coloured output. Use the ``--pdb`` option
+to start the Python_ debugger when a test fails.