Merge branch 'master' of github-as-renaud:obiwankennedy/DiceParser

1 files changed, 85 insertions, 2 deletions

diff --git a/HelpMe.md b/HelpMe.md
index 484a972..9a37daf 100644
--- a/HelpMe.md
+++ b/HelpMe.md
@@ -1,5 +1,9 @@
 # Documentation:
 
+## Irc and Chat
+
+Please, remember it is important to preffix all you command by `!`. This will allow the system to identify your command. To clarify the documentation, the `!` is not repeated before all commands.
+
 ## How to roll a die 
 
 It is real simple. you have to call:
@@ -40,13 +44,13 @@ Thanks of several operations and option, you can tune a bit you rolling command.
 
 > kX
 
-The option sorts the resulting die list and select the X better.
+The option sorts the resulting die list and select the X best dice.
 
 ### Keep And Explose
 
 > KX
 
-Dice explose if their value are at the die maximum, the option sorts the resulting die list, the it selects the X better.
+Dice explose if their value are at the die maximum, the option sorts the resulting die list, the it selects the X best dice.
 
 ### Sorting
 
@@ -91,7 +95,86 @@ Result: 24
 
 Result: 20
 
+> (3+4)*2
+
+Result: 14
+
+> 7/2
+
+Result: 3.5
+
+> (3+2D6)D10
+
+Roll 2 dice and add 3 to the sum of those dice. Then the result is used for rolling dice.
+
+
+## Arithmetic and Dice
+
+It is possible to use arithmetic opearation on dice. Please pay attention that the default operation to translate a 
+dice list to scalar is the sum. So if you roll `3d6`, the result will be a list with 3 values {2, 5 ,1}. Now, we 
+change a bit the command `3d6+4`: It is resolved like this: {2, 5 ,1} = 8; 8+4 = 12. The final result is 12.
+
+> 3d6+4
+
+Roll 3 dice; sum the result; and add 4
+
+> 10D10-2
+
+Roll 10 dice; sum the result; and then substract 2
+
+> 87-1D20
+
+Substract the result of 1 die to 87
+
+> (6-4)D10
+
+Substract 4 to 6 and then roll two dice. 
+
+> 1D10/2
+
+Divide by 2 the result of 1 die.
+
+
+## Validator
+
+There are three kind of Validator:
+-Scalar
+-Range
+-Boolean expression
+
+
+Any operator which requires validator (such as `a,r,e,c') can use those three kind.
+
+### Scalar 
+
+The scalar value sets the validator on eguality between the dice value and the validator
+
+> 4d10e10
+
+This command means : roll 4 dice and they explose on 10.
+
+### Range
+
+The range is defined as two bound. You have to use square brackets and the two bound are separated by `-`.
+
+> 4d10c[8-10]
+
+### Boolean Condition
+
+The command counts how many dice have values between >=8 and <=10.
+
+> 4d10c[>7]
+
+The command counts how many dice are aboved 7.
+
+#### Logic Operator
 
+The Rolisteam Dice Parser allows you to use several logic operator:
+* Egual : =
+* Greater or egual :  >=
+* Lesser or egual : <=
+* Lesser : <
+* Greater : >
 
 ## Examples