From 108753dfb826ce7b60ebd7218e36364b27fdbc9e Mon Sep 17 00:00:00 2001
From: Joe bellus <joe@5sigma.io>
Date: Mon, 10 Mar 2025 21:32:07 -0400
Subject: [PATCH] README

Added readme with contribution instructions
---
 .github/workflows/publish.yaml |  4 +---
 README.md                      | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+), 3 deletions(-)
 create mode 100644 README.md

diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
index 083d666..a02c891 100644
--- a/.github/workflows/publish.yaml
+++ b/.github/workflows/publish.yaml
@@ -23,8 +23,6 @@ jobs:
           key: ${{ runner.os }}-tectonic-
       - name: Compile latex
         run: ./tectonic book.tex
-      - name: Rename PDF
-        run: mv book.pdf ${{ steps.extract_branch.outputs.branch }}.pdf
       - name: Upload
         uses: VAllens/gitea-publish-generic-packages@v1
         env:
@@ -33,7 +31,7 @@ jobs:
           token: ${{ secrets.token }}
           package_version: ${{ github.sha }}
           files: |-
-            ${{ steps.extract_branch.outputs.branch }}.pdf
+            book.pdf
       - uses: actions/cache@v3
         name: Tectonic cache
         with:
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5534bf0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Rendering the document
+
+## Install GIT
+
+Install git based on your OS https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
+
+## Download Tectonic
+
+Tectonic is used to render the latex
+
+### Linux/MacOS
+
+The following shell command will download the latex tectonic binary.
+
+```
+curl --proto '=https' --tlsv1.2 -fsSL https://drop-sh.fullyjustified.net |sh
+```
+
+### NixOS
+
+Add the `tectonic` package.
+
+### Windows
+
+Download the prebuilt binary from https://github.com/tectonic-typesetting/tectonic/releases/download/tectonic%400.15.0/tectonic-0.15.0-x86_64-pc-windows-msvc.zip
+
+## Clone the repository and render the document
+
+```
+git clone https://git.5sigma.io/EdgeOfNight/core-book.git
+cd core-book
+/path/to/tectonic book.tex
+```