diff --git a/README.md b/README.adoc similarity index 71% rename from README.md rename to README.adoc index e3b9d4c..860ff89 100644 --- a/README.md +++ b/README.adoc @@ -1,7 +1,31 @@ -# LaTeX style files for numpex deliverables. += LaTeX style files for NumPEx deliverables. +:figure-caption!: -## Basic usage: +.Zenodo DOI +-- +image::https://zenodo.org/badge/DOI/10.5281/zenodo.13224368.svg[DOI, link=https://doi.org/10.5281/zenodo.13224368] +-- + +.GitHub Information +-- +image:https://img.shields.io/github/v/release/numpex/deliverable.template[GitHub Release] +image:https://img.shields.io/github/actions/workflow/status/numpex/deliverable.template/latex.yml[GitHub Actions Workflow Status] +image:https://img.shields.io/github/downloads/numpex/deliverable.template/total[GitHub Downloads (all assets, all releases)] +-- + +== Introduction + +This repository contains a LaTeX style for deliverables in the context of the French initiative for Exascale computing NumPEx. + +This style is based on the deliverable template provided by the European project Hyperride. + +== Basic usage: + +Create a repository for your deliverable and use this repo as template. + +.Create a new repository from deliverable.template +image::graphics/create-repo-from-template.png[] The basic structure of a deliverable formatted according with these styles should be (minimally): @@ -73,11 +97,12 @@ styles should be (minimally): \bibliographystyle{apacite} %% recommended \{document} -## Further details +== Further details See deliverable.template.tex/deliverable.template.pdf in this directory. If you have any thoughts on how to improve this style, feel free to implement them and share your results. The same goes for bug fixes. + Just clone the project and 'Have fun!' \ No newline at end of file diff --git a/graphics/create-repo-from-template.png b/graphics/create-repo-from-template.png new file mode 100644 index 0000000..3cb22b0 Binary files /dev/null and b/graphics/create-repo-from-template.png differ