From 0a675f91d63ffadad89f73068141ae778d7394f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9rome=20Eertmans?= <jeertmans@icloud.com>
Date: Wed, 29 May 2024 17:40:23 +0200
Subject: [PATCH] chore(paper): add rendering help

---
 .gitignore            |  5 ++++-
 papers/joss/README.md | 18 ++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)
 create mode 100644 papers/joss/README.md

diff --git a/.gitignore b/.gitignore
index 1afce9f..216022c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,4 +9,7 @@ docs/source/examples_gallery/
 docs/source/gen_modules/backreferences/
 docs/source/sg_execution_times.rst
 
-paper/pgf/
+# Papers build artifacts
+papers/eucap2024/pgf/
+papers/joss/paper.pdf
+papers/joss/paper.jats
diff --git a/papers/joss/README.md b/papers/joss/README.md
new file mode 100644
index 0000000..d8b1a6f
--- /dev/null
+++ b/papers/joss/README.md
@@ -0,0 +1,18 @@
+# JOSS Paper
+
+This folder contains the source files used to generate
+the paper we submitted to the
+[Journal of Open Source Software](https://joss.theoj.org/).
+
+You can generate a draft version of the PDF with:
+
+```bash
+docker run --rm \
+    --volume $PWD/papers/joss:/data \
+    --user $(id -u):$(id -g) \
+    --env JOURNAL=joss \
+    openjournals/inara
+```
+
+The `$PWD/papers/joss` assumes that you are running
+the command from the root directory of this repository.