Readme updates and a smal build script

BitlyTwiser · Sep 20, 2024 · c51da2a · c51da2a
1 parent afc9d09
commit c51da2a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,22 @@
+name: Build and Test
+
+on:
+  pull_request:
+    branches:
+      - main 
+  push:
+    branches:
+      - main 
+
+jobs:
+  build-linux:
+    name: Build & Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Zig
+        run: "sudo snap install zig --classic --beta"
+
+      - name: Build & Test
+        run: zig build test
diff --git a/README.md b/README.md
@@ -37,4 +37,6 @@ Zig (at the time of this writing) does not have a solid way of directly adjustin
 
 will only adjust the env map for the scope of this execution (i.e. scope of the current calling function). After function exit, the map goes back to its previous state.
 
+Therefore, we do make a C call to store the env variables that are parsed. So linking libC and running tests with ```--library c``` is needed
+
 Using the package is as simple as the above code examples. import below using zig zon, load the .env, and access the variables as needed using std.process.EnvMap :)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -37,4 +37,6 @@ Zig (at the time of this writing) does not have a solid way of directly adjustin

		will only adjust the env map for the scope of this execution (i.e. scope of the current calling function). After function exit, the map goes back to its previous state.

		Therefore, we do make a C call to store the env variables that are parsed. So linking libC and running tests with ```--library c``` is needed

		Using the package is as simple as the above code examples. import below using zig zon, load the .env, and access the variables as needed using std.process.EnvMap :)