/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

  • Committer: Gustav Hartvigsson
  • Date: 2020-06-07 20:00:45 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20200607200045-f4ifi15p2t40apa3
* Woops again...

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
1
 
# Vala/Very Quick Dice Roller
2
 
 
3
 
To see README about libvqdr, please see ./src/libvqdr/README.md
4
 
 
5
 
# Building
6
 
 
7
 
```
 
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
BUILDING
 
13
------------
8
14
$ mkdir build
9
15
$ cd build
10
16
$ meson ..
11
17
$ ninja
12
 
```
 
18
------------
 
19
 
 
20
DICE EXPRESSION SYNTAX
 
21
 
 
22
A dice expression is simple.
 
23
 
 
24
---- Basics ----
 
25
[n]d[m], [n]t[m] - [n] dices with [m] sides.
 
26
[e1] [op] [e2]   - Use operator [op] on expressions [e1] and [e2]
 
27
 
 
28
[func]([e...])   - Use function [func] on the expression(s) [e...]
 
29
----------------
 
30
 
 
31