forked from gCubeCI/Templates
Update README (some sections removed, others expanded).
This commit is contained in:
parent
62a22842aa
commit
c2d5727c13
67
README.md
67
README.md
|
@ -1,6 +1,23 @@
|
||||||
# Project Title
|
# Project Title
|
||||||
|
|
||||||
One Paragraph of project description goes here
|
One Paragraph of project description goes here.
|
||||||
|
|
||||||
|
# gCube Framework
|
||||||
|
This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an
|
||||||
|
open-source software toolkit used for building and operating Hybrid Data
|
||||||
|
Infrastructures enabling the dynamic deployment of Virtual Research Environments
|
||||||
|
by favouring the realisation of reuse oriented policies.
|
||||||
|
|
||||||
|
The projects leading to this software have received funding from a series of European Union programmes including:
|
||||||
|
|
||||||
|
- the Sixth Framework Programme for Research and Technological Development
|
||||||
|
- DILIGENT (grant no. 004260);
|
||||||
|
- the Seventh Framework Programme for research, technological development and demonstration
|
||||||
|
- D4Science (grant no. 212488), D4Science-II (grant no.239019), ENVRI (grant no. 283465), EUBrazilOpenBio (grant no. 288754), iMarine(grant no. 283644);
|
||||||
|
- the H2020 research and innovation programme
|
||||||
|
- BlueBRIDGE (grant no. 675680), EGIEngage (grant no. 654142), ENVRIplus (grant no. 654182), Parthenos (grant no. 654119), SoBigData (grant no. 654024);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Structure of the project
|
## Structure of the project
|
||||||
|
|
||||||
|
@ -11,14 +28,6 @@ Releavant information about how the repository is organized.
|
||||||
|
|
||||||
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.
|
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
|
### Installing
|
||||||
|
|
||||||
A step by step series of examples that tell you how to get a development env running
|
A step by step series of examples that tell you how to get a development env running
|
||||||
|
@ -37,25 +46,6 @@ until finished
|
||||||
|
|
||||||
End with an example of getting some data out of the system or using it for a little demo
|
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
|
## Deployment
|
||||||
|
|
||||||
|
@ -71,13 +61,30 @@ Add additional notes about how to deploy this on a live system
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Relavant wiki link(s).
|
Relevant wiki link(s).
|
||||||
|
|
||||||
## Authors
|
## Authors
|
||||||
|
|
||||||
* **John Doe** - *Initial work* - [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
|
* **John Doe** ([ORCID](https://orcid.org/...-...)) - *Initial work* @ [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
|
||||||
* **...** - ...
|
* **...** - ...
|
||||||
|
|
||||||
|
## How to Cite this Software
|
||||||
|
|
||||||
|
Tell people how to cite this software.
|
||||||
|
* Cite an associated paper?
|
||||||
|
* Use a specific BibTeX entry for the software?
|
||||||
|
|
||||||
|
@Manual{,
|
||||||
|
|
||||||
|
title = {.. projec title ..},
|
||||||
|
author = {{Infrascience Group}},
|
||||||
|
organization = {ISTI - CNR},
|
||||||
|
address = {Pisa, Italy},
|
||||||
|
year = 2019,
|
||||||
|
note = {...},
|
||||||
|
url = {http://www.http://gcube-system.org/}
|
||||||
|
}
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details
|
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details
|
||||||
|
|
Loading…
Reference in New Issue