Merge branch '__rultor'

README.md

@@ -86,9 +86,6 @@ Total score: 127.67642529949538
 4 is the total number of found patterns
 ```
 
-The score is the relative importance of the pattern (there is no range for it). 
-The larger value is the more important pattern is.
-
 You can use `format=long`. In this case all results will be sorted by a line number:
 
 ```
@@ -175,6 +172,33 @@ You can also choose xml format. It will have the same format as `text` mode, but
 </report>
 
 ```
+The score is the relative importance of the pattern (there is no range for it). 
+The larger score is, the most important pattern is. 
+E.g., if you have 2 patterns, first you need to fix the pattern with the score 3.55215:
+
+```
+/mnt/d/src/java/SampleTests.java[100]: Partial synchronized (P14: 3.55215 1/4)
+/mnt/d/src/java/SampleTests.java[106]: Partial synchronized (P14: 3.55215 1/4)
+/mnt/d/src/java/SampleTests.java[113]: Partial synchronized (P14: 3.55215 1/4)
+/mnt/d/src/java/SampleTests.java[43]: Non final attribute (P12: 0.71568 2/4)
+/mnt/d/src/java/SampleTests.java[44]: Non final attribute (P12: 0.71568 2/4)
+/mnt/d/src/java/SampleTests.java[122]: Var declaration distance for 5 lines (P20_5: 0.51175 3/4)
+/mnt/d/src/java/SampleTests.java[59]: Force Type Casting (P5: 0.42144 4/4)
+```
+The class calculates average score among all patterns score.
+
+```
+/mnt/d/src/java/SampleTests.java score: 5.201028817472813
+```
+
+The total score is an average among all java files in a project (folder you've set to analyze)
+```
+Total average score: 4.0801854775508914
+```
+
+If you have 2 scores of different projects, the worst project is that one which has the highest score.
+
+
 
 Model is automatically installed with *aibolit* package, but you can also try your own model