Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
prudhomm committed Aug 19, 2024
1 parent 2f3d130 commit 8d03201
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md → README.adoc
Original file line number Diff line number Diff line change
@@ -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):
Expand Down Expand Up @@ -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!'
Binary file added graphics/create-repo-from-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d03201

Please sign in to comment.