https://github.com/bernardo-mg/dice-notation-java-cli
A CLI for rolling dice expressions
https://github.com/bernardo-mg/dice-notation-java-cli
cli dice dice-notation
Last synced: 4 months ago
JSON representation
A CLI for rolling dice expressions
- Host: GitHub
- URL: https://github.com/bernardo-mg/dice-notation-java-cli
- Owner: Bernardo-MG
- License: apache-2.0
- Created: 2020-07-18T19:06:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T07:51:44.000Z (over 2 years ago)
- Last Synced: 2025-01-23T09:11:20.435Z (6 months ago)
- Topics: cli, dice, dice-notation
- Language: Java
- Homepage:
- Size: 165 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Dice Notation Tools for Java CLI
CLI for running the [Dice Notation Tools][dice-notation-tools] through line command.
To run the project first package it:
```
mvn clean package
```Or download it from [Github Packages][github_package].
In both cases the JAR will be a runnable Java file. It can be executed like this:
```
java -jar target/dice.jar roll 1d6
```To show other commands:
```
java -jar target/dice.jar -h
```[][site-release]
[][site-develop][][javadoc-release]
[][javadoc-develop]## Features
- CLI for [Dice Notation Tools][dice-notation-tools]
- Executable JAR## Documentation
Documentation is always generated for the latest release, kept in the 'master' branch:
- The [latest release documentation page][site-release].
- The [latest release Javadoc site][javadoc-release].Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
- The [the latest snapshot documentation page][site-develop].
- The [latest snapshot Javadoc site][javadoc-develop].### Building the docs
The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
```
mvn verify site
```The verify phase is required, otherwise some of the reports won't be generated.
## Collaborate
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project### Issues management
Issues are managed at the GitHub [project issues tracker][issues], where any Github user may report bugs or ask for new features.
### Getting the code
If you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
## License
The project has been released under the [MIT License][license].
[github_package]: https://github.com/Bernardo-MG?tab=packages&repo_name=dice-notation-java-cli
[issues]: https://github.com/bernardo-mg/dice-notation-java-cli/issues
[javadoc-develop]: https://docs.bernardomg.com/development/maven/dice-notation-java-cli/apidocs
[javadoc-release]: https://docs.bernardomg.com/maven/dice-notation-java-cli/apidocs
[license]: https://www.opensource.org/licenses/mit-license.php
[scm]: https://github.com/bernardo-mg/dice-notation-java-cli
[site-develop]: https://docs.bernardomg.com/development/maven/dice-notation-java-cli
[site-release]: https://docs.bernardomg.com/maven/dice-notation-java-cli[dice-notation-tools]: https://github.com/Bernardo-MG/dice-notation-java