Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Hunter <[email protected]>
  • Loading branch information
ianfhunter authored Dec 29, 2022
1 parent 30f0d8e commit e098eef
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ GNOLL was written to be the definitive solution to dice notation. The core has b
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
![Julia](https://img.shields.io/badge/-Julia-9558B2?style=for-the-badge&logo=julia&logoColor=white)
![Perl](https://img.shields.io/badge/perl-%2339457E.svg?style=for-the-badge&logo=perl&logoColor=white)
![PHP](https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge&logo=php&logoColor=white)
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![R](https://img.shields.io/badge/r-%23276DC3.svg?style=for-the-badge&logo=r&logoColor=white)
![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)
Expand Down Expand Up @@ -76,9 +77,10 @@ pip3 install GNOLL

Then, in your code:
```python
from gnoll.parser import roll
from gnoll import roll
roll("1d20")
>> 7
>> (0, [[12]], None)
# (return code, final result, dice breakdown (if enabled))
```

### 🛠️ Installing From Source
Expand All @@ -96,9 +98,11 @@ make test
Or, just try some commands yourself!

```bash
$ ./dice 1d20
$ ./build/dice 1d20
20
```
If you would like to run the 'dice' command from anywhere, use `make install` to add the executable to your path.

(Note that not all commands may not be able to be used this way as some symbols are reserved for use by different terminal interfaces (e.g. bash uses ! and #))

For languages other than Python/C/C++ call the corresponding make target after the commands above.
Expand Down Expand Up @@ -130,6 +134,7 @@ Individual licensing arrangements can be made if this is an issue for your proje
## 👏 Acknowledgments

- **Billie Thompson** - *README & Contribution Templates* - [PurpleBooth](https://github.com/PurpleBooth)
- [Markdown Badges](https://github.com/Ileriayo/markdown-badges)

## 🏗️ Built With

Expand Down

0 comments on commit e098eef

Please sign in to comment.