Add README.md

This commit is contained in:
Maciej Krzyżanowski 2024-08-25 01:11:19 +02:00
parent ff8ede2361
commit e72623880d

23
README.md Normal file
View File

@ -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`.