search

ianfhunter / GNOLL

GNOLL is an efficient dice notation parser for multiple programming languages that supports a wide set of dice notation
https://www.ianhunter.ie/GNOLL/
GNU General Public License v3.0
39 stars 23 forks source link

Installation instructions slightly wrong? #420

Closed steven-murray closed 1 year ago

steven-murray commented 1 year ago

Following the installation instructions on the README, after doing the make all, it seems to place the binary dice in the build/ directory, not the top-level directory, which seems to be what is suggested in the README. Along with this, can I suggest that the main command-line binary be installable to a main path?

github-actions[bot] commented 1 year ago

Thanks for filing an issue! We'll get back to you as soon as we can with a response.

ianfhunter commented 1 year ago

Thank you for the feedback, I had installing to a main path on my backlog, but it kept falling by the wayside.

In #421 , make install will install the executable to /usr/local/bin/. I've also updated the documentation to add this step and to correct the path of the uninstalled executable. GitHub actions tests the installation too

steven-murray commented 1 year ago

Thanks, looks like that works as advertised now. However, there is a slight documentation issue that's related (can create another issue if you prefer...). The issue is that the Python example on the readme says that the result of roll("1d20") should be a single integer number. However, I get (0, [[12]], []). Again, not a huge issue, but is a little startling if following the basic examples. While you're at it, the CLI interface returns Result: 14; instead of just "14".

steven-murray commented 1 year ago

Looks good now.