Skip to content

Commit c8db2ec

Browse files
committed
add README.md
1 parent 9ec481f commit c8db2ec

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[![CI](https://github.com/allyourcodebase/mbedtls/actions/workflows/ci.yaml/badge.svg)](https://github.com/allyourcodebase/mbedtls/actions)
2+
3+
# Mbed TLS
4+
5+
This is [Mbed TLS](https://github.com/Mbed-TLS/mbedtls), packaged for [Zig](https://ziglang.org/).
6+
7+
## Installation
8+
9+
First, update your `build.zig.zon`:
10+
11+
```
12+
# Initialize a `zig build` project if you haven't already
13+
zig init
14+
zig fetch --save git+https://github.com/allyourcodebase/mbedtls.git
15+
```
16+
17+
You can then import `mbedtls` in your `build.zig` with:
18+
19+
```zig
20+
const mbedtls_dependency = b.dependency("mbedtls", .{
21+
.target = target,
22+
.optimize = optimize,
23+
});
24+
your_exe.root_module.linkLibrary(mbedtls_dependency.artifact("mbedtls"));
25+
```

0 commit comments

Comments
 (0)