add README and screenshots #3

README.adoc

@@ -0,0 +1,91 @@
+= Template Repository for Articles
+
+== Image Naming Convention
+
+To ensure compatibility with platforms like HAL, arXiv, and Overleaf, name your images with the `img-*` prefix and store them in the same directory as the `.tex` file. This makes it easier to manage and upload your images along with your LaTeX document.
+
+*Accepted formats*: PDF, PNG, JPG
+
+*Example*:
+- `img-figure1.pdf`
+- `img-figure2.png`
+- `img-figure3.jpg`
+
+== Using References from Zotero via Overleaf
+
+To manage your references with Zotero and integrate them seamlessly into Overleaf, follow these steps:
+
+1. Export Zotero Library to BibTeX
+   - Open Zotero and select the references you want to export.
+   - Go to `File > Export Library`.
+   - Choose `BibTeX` as the format and save the file (e.g., `references.bib`).
+
+2. Upload BibTeX File to Overleaf
+   - Open your project in Overleaf.
+   - Click on the `Upload` button (top-left corner) and upload your `references.bib` file.
+
+3. Include the Bibliography in Your LaTeX Document
+   Add the following lines to your `.tex` file to include the bibliography:
++
+[source,latex]
+----
+\documentclass{article}
+\usepackage{graphicx}
+\usepackage{natbib}
+\begin{document}
+
+% Your content here
+
+\bibliographystyle{plainnat}
+\bibliography{references}
+
+\end{document}
+----
+4. Cite References in Your LaTeX Document
+Use the `\cite{}`` command to cite references within your document. For example:
++
+[source,latex]
+----
+As shown by \citet{AuthorYear}, this method is effective.
+----
+
+= GitHub Action Workflow for LaTeX Compilation
+
+The GitHub Action workflow :
+- compiles a LaTeX document 
+- uploads the resulting PDF
+- creates a release with the PDF as an asset when a new tag is pushed of the type `v*`, eg `v1.0.0` or a pre-release `v1.0.0-preview.1`
+
+To create a git tag, do the following:
+[source,bash]
+----
+git tag -a v1.0.0 -m "Version 1.0.0"
+git push origin v1.0.0
+----
+
+== Steps to Use the Template Repository
+
+Create a New Repository:: Use the git template repository feature to create a new repository based on this template.
++
+image::img-create-repo.png[]
+
+Clone the Repository:: Clone the repository to your local machine.
++
+[source,bash]
+----
+git clone https://github.com/feelpp/my-repo.git
+cd my-repo
+----
++
+image::img-repo-test.png[]
+
+Add Your LaTeX Source Files:: Place your .tex file and image files (img-*.pdf, img-*.png, img-*.jpg) in the repository.
+
+Commit and Push Changes:: Commit your changes and push them to the repository.
++
+[source,bash]
+----
+git add .
+git commit -m "Add initial LaTeX document and images"
+git push origin main
+----