Skip to content

Bernardo-MG/dice-notation-java-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dice Notation Tools for Java CLI

CLI for running the Dice Notation Tools through line command.

To run the project first package it:

mvn clean package

Or download it from Github Packages.

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

Release docs Development docs

Release javadocs Development javadocs

Features

Documentation

Documentation is always generated for the latest release, kept in the 'master' branch:

Documentation is also generated from the latest snapshot, taken from the 'develop' branch:

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, 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, 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.