Skip to content

Instantly share code, notes, and snippets.

@bzinoun
Last active January 31, 2020 08:22
Show Gist options
  • Save bzinoun/68c8fd0d64f2b2b8f4e3b275b0b75188 to your computer and use it in GitHub Desktop.
Save bzinoun/68c8fd0d64f2b2b8f4e3b275b0b75188 to your computer and use it in GitHub Desktop.
# 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 end to end tests
Explain what these tests test and why
```
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](https://maven.apache.org/) - Dependency Management
* [JAVA](.....) - ....etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment