From 8a5218528bd56b97bde983b07c7cc8f49cf07617 Mon Sep 17 00:00:00 2001
From: Nicolas Casajus <ahasverus@users.noreply.github.com>
Date: Fri, 29 Mar 2024 16:40:02 +0100
Subject: [PATCH] doc: setup vignette

---
 DESCRIPTION            |  4 ++++
 codemeta.json          | 28 +++++++++++++++++++++++++++-
 vignettes/.gitignore   |  2 ++
 vignettes/calendar.Rmd | 18 ++++++++++++++++++
 4 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 vignettes/.gitignore
 create mode 100644 vignettes/calendar.Rmd

diff --git a/DESCRIPTION b/DESCRIPTION
index 8a11faa..d36ca92 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -18,6 +18,10 @@ License: GPL (>= 2)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1
+VignetteBuilder: knitr
 Imports: 
     graphics,
     grDevices
+Suggests: 
+    knitr,
+    rmarkdown
diff --git a/codemeta.json b/codemeta.json
index 8e4956b..6cce30b 100644
--- a/codemeta.json
+++ b/codemeta.json
@@ -47,6 +47,32 @@
       "@id": "https://orcid.org/0000-0002-5537-5294"
     }
   ],
+  "softwareSuggestions": [
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "knitr",
+      "name": "knitr",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=knitr"
+    },
+    {
+      "@type": "SoftwareApplication",
+      "identifier": "rmarkdown",
+      "name": "rmarkdown",
+      "provider": {
+        "@id": "https://cran.r-project.org",
+        "@type": "Organization",
+        "name": "Comprehensive R Archive Network (CRAN)",
+        "url": "https://cran.r-project.org"
+      },
+      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
+    }
+  ],
   "softwareRequirements": {
     "1": {
       "@type": "SoftwareApplication",
@@ -60,7 +86,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "239.941KB",
+  "fileSize": "378.947KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",
diff --git a/vignettes/.gitignore b/vignettes/.gitignore
new file mode 100644
index 0000000..097b241
--- /dev/null
+++ b/vignettes/.gitignore
@@ -0,0 +1,2 @@
+*.html
+*.R
diff --git a/vignettes/calendar.Rmd b/vignettes/calendar.Rmd
new file mode 100644
index 0000000..1f1e1d0
--- /dev/null
+++ b/vignettes/calendar.Rmd
@@ -0,0 +1,18 @@
+---
+title: "Get started"
+output: rmarkdown::html_vignette
+vignette: >
+  %\VignetteIndexEntry{Get started}
+  %\VignetteEngine{knitr::rmarkdown}
+  %\VignetteEncoding{UTF-8}
+---
+
+```{r include=FALSE}
+knitr::opts_chunk$set(collapse  = TRUE,
+                      comment   = "#>",
+                      out.width = "100%",
+                      dpi       = 96,
+                      fig.align = "center")
+```
+
+Coming soon...