Adding tinytex and more files

.github/workflows/website.yaml → .github/workflows/check-qmd-render.yaml

@@ -1,5 +1,4 @@
-name: Render Website
-
+name: Check whether the files render
 on:
   push:
     branches:
@@ -19,16 +18,24 @@ jobs:
       image: rocker/tidyverse:4.4.0
 
     steps:
+      # Check out the repository (git clone)
       - uses: actions/checkout@v4
 
+      # Setup TinyTeX
+      - name: Setup TinyTeX
+        uses: r-lib/actions/setup-tinytex@v2
+
+      # Install dependencies (R packages)
       - name: Install dependencies
         run: |
           install2.r data.table slurmR
     
+      # Render the slides/report using quarto
       - name: Render ${{ matrix.file }}
         run: |
           quarto render ${{ matrix.file }}.qmd
     
+      # Save the rendered slides/report as an artifact
       - name: Save as artifact
         uses: actions/upload-artifact@v4
         with:

README.md

@@ -3,13 +3,26 @@
 The template project has the following files:
 
 - `README.md`: this file.
+- `data/`: a folder for data files.
 - `.gitignore`: a file that tells git which files to ignore.
 - `slides.qmd`: a presentation in quarto format.
 - `report.qmd`: a report in quarto format.
-- `.github/workflows/website.yaml`: The workflow that builds the html and pdf files. New dependencies can be added on the step "Install dependencies"; the following installs the R packages data.table and slurmR from CRAN:
+- `.github/workflows/check-qmd-render.yaml`: The workflow that builds the html and pdf files. New dependencies can be added on the step "Install dependencies"; the following installs the R packages data.table and slurmR from CRAN:
 
     ```yaml
     - name: Install dependencies
     run: |
         install2.r data.table slurmR
-    ```
+    ```
+
+  This workflow should complete without errors before you submit your project.
+
+## Instructions
+
+1. Use the qmd files to write your report and slides.
+
+2. Add any needed files (figures, C++, data, etc.) to the repository.
+
+2. If needed, add additional dependencies to the workflow file.
+
+3. Ensure the [report.pdf](report.pdf) and [slides.html](slides.html) files are generated.

data/README.md

@@ -0,0 +1,3 @@
+# Data folder
+
+Any data your project holds should go here.