Index: /branches/mk/README
===================================================================
--- /branches/mk/README (revision 117)
+++ /branches/mk/README (revision 120)
@@ -187,6 +187,6 @@
 
     * README: 30
-    * LICENCE/COPYING: 30
-    * ANNOUNCE/CHANGELOG: 20
+    * LICENCE/COPYING: 30 [#oneof]_
+    * ANNOUNCE/CHANGELOG: 20 [#oneof]_
     * INSTALL: 20
     * AUTHORS: 10
@@ -198,10 +198,10 @@
   * package contain directories listed below
 
-    * doc/docs: 30
-    * test/tests: 30
-    * demo/example/examples: 10
-
-  * code is documented by docstrings: 100
-  * docstrings have proper formatting (like epytext or reST): 30
+    * doc/docs: 30 [#oneof]_
+    * test/tests: 30 [#oneof]_
+    * demo/example/examples: 10 [#oneof]_
+
+  * code is documented by docstrings: 100 [#docstrings]_
+  * docstrings have proper formatting (like epytext or reST): 30 [#formatted]_
 
 * Code Kwalitee
@@ -213,4 +213,14 @@
 listed above. Score is presented in absolute range (number of points)
 and relative (percent of gathered points compared to maximum).
+
+.. [#oneof] It is enough for a package to contain only one of listed files.
+.. [#docstrings] Number of points is proportional to percent of documentable objects
+   (module, class or function) that have docstrings. For example, if
+   you have 50 documentable objects and 32 of them have docstrings
+   your code will get 64 points ('cause 64% of objects are documented).
+.. [#formatted] Number of points depends on number of docstrings that are found
+   to contain one of known markup. Currently ReST, epytext and javadoc are
+   recognized. We give 10 points for 25% of formatted docstrings, 20 points
+   for 50% and 30 points for 75%.
 
 Sample output
@@ -257,3 +267,3 @@
 by the Cheesecake metrics.
 
-.. footer:: Last modified 2006-07-30 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_.
+.. footer:: Last modified 2006-08-02 by `Michal Kwiatkowski <http://joker.linuxstuff.pl>`_.