92 lines
1.8 KiB
Markdown
92 lines
1.8 KiB
Markdown
# Project Title
|
|
|
|
One Paragraph of project description goes here
|
|
|
|
## Structure of the project
|
|
|
|
Description of the Maven modules (if any).
|
|
Releavant information about how the repository is organized.
|
|
|
|
## 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
|
|
|
|
* [OpenJDK](https://openjdk.java.net/) - The JDK used
|
|
* [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services
|
|
* [Jersey](https://jersey.github.io/) - JAX-RS runtime
|
|
* [Maven](https://maven.apache.org/) - Dependency Management
|
|
* ...
|
|
|
|
## Documentation
|
|
|
|
Relavant wiki link(s).
|
|
|
|
## Authors
|
|
|
|
* **John Doe** - *Initial work* - [ISTI-CNR]Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
|
|
* **...** - ...
|
|
|
|
## License
|
|
|
|
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details
|
|
|
|
## Acknowledgments
|
|
|
|
* Hat tip to anyone whose code was used
|
|
* Inspiration
|
|
* etc
|
|
|
|
|