ndice 0.1.0

A cli dice roller
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

# ndice
> Role a `n`ice `dice` (or `[n|d]ice`?)

![Header image](assets/github-header.png)

# Table of Contents
<!-- BEGIN mktoc -->

- [About](#about)
- [Installation](#installation)
  - [Binary](#binary)
  - [Cargo ](#cargo)
- [Usage ](#usage)
- [Contributing](#contributing)
  - [Where to start?](#where-to-start)
  - [Tooling](#tooling)
  - [Install dev build](#install-dev-build)
- [License](#license)
<!-- END mktoc -->

## About

`ndice` is a cli dice roller. 

Dices are writen in the format `${number}d{$sides}`, e.g. `1d6` means 1 six-sided dice. There's no limit to sides so a non-existing dice like `1d13` can be rolled. 

- Each space-speparated argument is counted as one dice notation.
- Dices can be mixed, so `ndice 1d6 2d8 4d10` works.
- Invalid arguments are ignored.


## Installation
[⬆️ Back to Top](#table-of-contents)

### Binary

Download a pre-compiled binary from the [release page](https://github.com/KevinGimbel/ndice/releases)

### Cargo 

Install with cargo: 
```sh
$ cargo install ndice
```

## Usage 
[⬆️ Back to Top](#table-of-contents)

```sh
$ ndice [dice]
```

Examples:

```sh
# Roll 1 six-sided dice
$ ndice 1d6
Rolled: ["d6 => 1"]
Result: 1
# Roll 2 8 sided dice and 2 four sided dice
$ ndice 2d8 2d4
Rolled: ["d8 => 6", "d8 => 3", "d4 => 1", "d4 => 1"]
Result: 11
```


## Contributing
[⬆️ Back to Top](#table-of-contents)

We love and welcome every form of contribution.

### Where to start?

Here are some good places to start:

* Issues with label [Good first issue](https://github.com/kevingimbel/mktoc/labels/good%20first%20issue)
* Issues with label [Documentation](https://github.com/kevingimbel/mktoc/labels/documentation)
* Providing example implementations or usage demos

### Tooling

- [mktoc](https://github.com/KevinGimbel/mktoc) is used for table of content generation in the README.md (neat!)
- [criterion](https://github.com/bheisler/criterion.rs) for benchmarking

### Install dev build

Sometimes it's nice to install a specific version of mktoc, this can be done with the following command:

```sh
# install specific commit
cargo install --git https://github.com/KevinGimbel/mktoc --force --rev $COMMIT_ID
# install branch
cargo install --git https://github.com/KevinGimbel/mktoc --force --branch $BRANCH_NAME
```


## License
[⬆️ Back to Top](#table-of-contents)

MIT, see LICENSE file.