From e72623880df8a5f33421564c387b488a970c570f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maciej=20Krzy=C5=BCanowski?= <krzmaciek@gmail.com>
Date: Sun, 25 Aug 2024 01:11:19 +0200
Subject: [PATCH] Add README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99f96a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# ⚡ Zig examples
+
+## Purpose
+1. Show that Zig is a cool language with real-world use cases and unique features
+2. Serve as learning resource for programmers learning Zig
+
+## Run
+Install Zig according to the instructions from https://ziglang.org/learn/getting-started/#installing-zig. You will need at least 0.13 version to run the examples.
+
+Firstly enter some example directory, e.g.:
+```
+cd zig-with-c
+```
+Some of examples may be run:
+```
+zig build run
+```
+and others may be tested:
+```
+zig build test
+zig build test --summary all # prints results summary
+```
+And some can do both things. You can check available options by running `zig build --help`.
\ No newline at end of file