From 65cf2fde2be09da95ed1c149006a8fe49e69734e Mon Sep 17 00:00:00 2001
From: Brendan Golden <git@brendan.ie>
Date: Sun, 11 Aug 2024 21:49:43 +0100
Subject: [PATCH] doc: add how to use it for getting LFS

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ea6ea87..d1385f6 100644
--- a/README.md
+++ b/README.md
@@ -32,4 +32,22 @@ jobs:
         with:
           input: 'compsoc_public'
           token: ${{ secrets.API_TOKEN_FORGEJO }}
-```
\ No newline at end of file
+```
+
+### Get LFS
+````yaml
+jobs:
+  build:
+    # build it using teh base nixos system, helps with caching
+    runs-on: nix
+    steps:
+      # get the repo first
+      - uses: https://code.forgejo.org/actions/checkout@v4
+      - name: "Get LFS objects"
+        uses: https://forgejo.skynet.ie/Skynet/actions-deploy-to-skynet/get_lfs@v3
+        with:
+          repository: ${{ gitea.repository }}
+          ref_name: ${{ gitea.ref_name }}
+      - name: "Build it locally"
+        run: nix build --verbose
+````
\ No newline at end of file