Files
DiceRoller/README.md

40 lines
837 B
Markdown

# DiceRoller
This program alows the user to make dice rols form with in the terminal.
just use the NodT format *Number of Dice Type* for example 1d20 with roll
one 20 sided die.
## Operation
The Command *roll* with the dice that you want to ues.
```shell
$ roll 1d20
```
you can also run more then once set at a time.
```shell
$ roll 1d20 3d6 5d8
```
## Building the Project
To build the project it requires:
- gcc
- cmake
First create the build directory.
```shell
$ mkdir build
```
Then run the cmake command.
This will put all of the build files in the build directory.
```shell
$ cmake -B build .
```
Now to build the program you can run.
This will build from the file in ./build
```shell
$ cmake --build build
```
## Includeing Into Your Project
If you want to include this into your own c/c++ just include the header file.