/vqdr/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/vqdr/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Gustav Hartvigsson
  • Date: 2020-06-07 18:48:24 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20200607184824-jf14f7a1b1di2i2q
* Initial code - far from done

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
 
                       Vala/Very Quick Dice Roller
2
 
 
3
 
To see README about libvqdr, please see ./src/libvqdr/README
4
 
 
5
 
VQDR will consist of two parts, the backend library, and the front end.
6
 
 
7
 
The backend libray, libvqdr, provides the logic for parsing dice expression
8
 
strings, and doing the calculations needed to perform the dice rolls.
9
 
 
10
 
The frontend has yet to be written.
11
 
 
12
 
For up-to-date code, go to:
13
 
https://launchpad.net/vqdr
14
 
 
15
 
BUILDING
16
 
------------
 
1
# Vala/Very Quick Dice Roller
 
2
 
 
3
To see README about libvqdr, please see ./src/libvqdr/README.md
 
4
 
 
5
# Building
 
6
 
 
7
```
17
8
$ mkdir build
18
9
$ cd build
19
10
$ meson ..
20
11
$ ninja
21
 
------------
22
 
 
23
 
DICE EXPRESSION SYNTAX
24
 
 
25
 
A dice expression is simple.
26
 
 
27
 
---- Basics ----
28
 
[n]d[m], [n]t[m] - [n] dices with [m] sides.
29
 
[e1] [op] [e2]   - Use operator [op] on expressions [e1] and [e2]
30
 
 
31
 
[func]([e...])   - Use function [func] on the expression(s) [e...]
32
 
----------------
33
 
 
34
 
 
 
12
```