Skip to content

Latest commit

 

History

History
89 lines (53 loc) · 1.66 KB

README.md

File metadata and controls

89 lines (53 loc) · 1.66 KB

Coverage: 34%

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system. Break down into which tests and what they do

Unit Tests

Explain what these tests test, why and how to run them

Give an example

Integration Tests

Explain what these tests test, why and how to run them

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Maven - Dependency Management

Versioning

We use SemVer for versioning.

Authors

License

This project is licensed under the MIT license - see the LICENSE.md file for details

For help in Choosing a license

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc