Browse Source

Move the templates in a dedicate folder. Add readme to explain the templates.

pull/1/head
Manuele Simi 3 years ago
parent
commit
ada74bf5bc
  1. 83
      README.md
  2. 0
      gCubeComponents/LICENSE.md
  3. 74
      gCubeComponents/README.md
  4. 0
      gCubeComponents/descriptor.xml
  5. 0
      gCubeComponents/profile.xml

83
README.md

@ -1,74 +1,17 @@
# Project Title
# TEMPLATES
One paragraph of project description goes here.
This project includes few templates for common files expected to be part of any gCube component holds in a Git repositoryu.
## Structure of the project
* Relevant information about how the repository is organized.
* Description of the Maven modules (if any).
* Any information needed to work with the code.
## 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
Relevant wiki link(s).
## Change log
See [Releases](https://code-repo.d4science.org/gCubeSystem/repository_name/releases).
## Authors
* **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
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.
## About the 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 and D4Science.org
- BlueBRIDGE (grant no. 675680), EGIEngage (grant no. 654142), ENVRIplus (grant no. 654182), Parthenos (grant no. 654119), SoBigData (grant no. 654024); DESIRA (grant no. 818194); ARIADNEplus (grant no. 823914); RISIS2 (grant no. 824091); PerformFish (grant no. 727610)
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc
List of available templates:
* [README.md](gCubeComponents/README.md)
* Your Git repo should have a readme file so that viewers know what your code does and how they can get started using it.
The readme displayed by default when a project opens in Git. It must be customized for each project.
* [LICENSE.md](gCubeComponents/LICENSE.md)
* The license file. It's common to all the projects. No need to change it.
* [profile.xml](gCubeComponents/profiles.xml)
* It profiles the gCube component. Need to be customized.
* [descriptor.xml](gCubeComponents/descriptor.xml)
* It supports the creation of an archive with the binary artifacts generated by the content of the repository. Customizable if needed.
All of them must be placed in the root directory of the Git repository.

0
LICENSE.md → gCubeComponents/LICENSE.md

74
gCubeComponents/README.md

@ -0,0 +1,74 @@
# Project Title
One paragraph of project description goes here.
## Structure of the project
* Relevant information about how the repository is organized.
* Description of the Maven modules (if any).
* Any information needed to work with the code.
## 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
Relevant wiki link(s).
## Change log
See [Releases](https://code-repo.d4science.org/gCubeSystem/repository_name/releases).
## Authors
* **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
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.
## About the 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 and D4Science.org
- BlueBRIDGE (grant no. 675680), EGIEngage (grant no. 654142), ENVRIplus (grant no. 654182), Parthenos (grant no. 654119), SoBigData (grant no. 654024); DESIRA (grant no. 818194); ARIADNEplus (grant no. 823914); RISIS2 (grant no. 824091); PerformFish (grant no. 727610)
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc

0
descriptor.xml → gCubeComponents/descriptor.xml

0
profile.xml → gCubeComponents/profile.xml

Loading…
Cancel
Save