aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/HelpMe.md
diff options
context:
space:
mode:
authorRenaud G <renaud@rolisteam.org>2014-12-07 02:22:17 +0100
committerRenaud G <renaud@rolisteam.org>2014-12-07 02:22:17 +0100
commit473e26f0637c8b8cea3180147fc5f3934297322c (patch)
tree446880ac12a651d9f6afba82cfe2f00f42d2c78e /HelpMe.md
parent80f04d4312273d670f7494028c922f653dc32b62 (diff)
downloadOneRoll-473e26f0637c8b8cea3180147fc5f3934297322c.tar.gz
OneRoll-473e26f0637c8b8cea3180147fc5f3934297322c.zip
First draft of the documentation.
Diffstat (limited to 'HelpMe.md')
-rw-r--r--HelpMe.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/HelpMe.md b/HelpMe.md
index e69de29..d14ad09 100644
--- a/HelpMe.md
+++ b/HelpMe.md
@@ -0,0 +1,57 @@
+# Documentation:
+
+## How to roll a die
+
+It is real simple. you have to call:
+> 1d6
+
+The first number is the count of dice you want to roll. The second number should be die's faces count.
+
+### Example
+> 1d6
+Roll one six-faced die.
+
+> 1d10
+Roll one ten-faced die.
+
+> 5d10
+Roll five ten-faced die.
+
+> 777d6
+Roll five ten-faced die.
+
+
+Thanks of several operations and option, you can tune a bit you rolling command.
+
+## List of operator
+*
+
+### 3D100
+Roll 3 dice with 100 faces
+
+### 10D10e[=10]s
+Roll 10 dice with 10 faces, 10 exploses, and sort the result.
+
+### 100291D66666666s
+roll 100291 dice with 66666666666 faces and sort result
+
+### 15D10c[>7]
+roll 15 dice with 10 faces and it counts number of dice which are above 7
+
+### 1D8+2D6+7
+roll 1 die with 8 faces and add the result to 2 dice with 6 faces and add 7.
+
+### D25
+roll 1 die with 25 faces
+
+### 88-1D20
+88 minus the value of 1 die of 20 faces
+
+### 8+8+8
+compute: 24
+
+
+
+### 100/28*3
+compute: 100/28 = 3
+3*3 = 9