Merge pull request #1 from CarletonURocketry/auto-compilation

Auto compilation

.github/workflows/pdf-gen.yml

@@ -0,0 +1,22 @@
+name: Build LaTeX document
+on: pull_request
+jobs:
+  build_latex:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v3
+      - name: Compile LaTeX document
+        uses: xu-cheng/latex-action@v3
+        with:
+          work_in_root_file_dir: true
+          root_file: |
+            data-logging-format/data_logging_format.tex
+            radio-packet-format/radio_packet_format.tex
+      - name: Upload documents
+        uses: actions/upload-artifact@v3
+        with:
+          name: Telemetry Specifications
+          path: |
+            radio-packet-format/radio_packet_format.pdf
+            data-logging-format/data_logging_format.pdf

README.md

@@ -3,6 +3,15 @@
 These two documents specify the format to be used for CUInSpace's telemetry data. This repository contains the source
 files for building the specification documents, which can be viewed in PDF format.
 
+## Accessing the Specifications
+
+Whenever changes are made, the LaTeX source files are compiled into PDF format. These PDFs are available under the
+`Actions` tab on GitHub.
+
+1. Once you click on the tab header, select the latest workflow run named `Auto compilation`.
+2. Look for a file called `Telemetry Specifications` under the `Artifacts` header.
+3. Click on it to download the specification PDFs in a zip file.
+
 ## Acknowledgements
 
 Thank you to Samuel Dewan, the original author of the specification.