Skip to content

Commit fbd8c18

Browse files
committed
readme: add additional information
1 parent ea53b83 commit fbd8c18

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

build.zig.zon

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
"build.zig.zon",
1414
"LICENSE",
1515
"LICENSE-LIBRESSL",
16-
"README.md",
16+
"readme.md",
1717
},
1818
}

readme.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,42 @@
22

33
This is [LibreSSL Portable](https://github.com/libressl/portable), packaged for [Zig](https://ziglang.org/).
44

5-
## Installation
5+
## Status
6+
7+
This project currently builds the three main LibreSSL libraries as static libraries:
8+
9+
- `libcrypto`: core cryptographic routines
10+
- `libssl`: OpenSSL 1.1 compatibility layer
11+
- `libtls`: LibreSSL's new cryptography API
12+
13+
Operating systems and hardware architectures are supported on a best-effort basis. Building for Linux, macOS, and Windows (mingw64) is directly tested by CI.
14+
15+
The command line programs `nc`, `ocspcheck`, and `openssl` are **not** currently built by this build system.
16+
17+
## Usage
618

719
First, update your `build.zig.zon`:
820

9-
```
21+
```sh
1022
# Initialize a `zig build` project if you haven't already
1123
zig init
12-
zig fetch --save <PLACEHOLDER>
24+
# replace <refname> with the version you want to use, e.g. 3.9.2
25+
zig fetch --save git+https://github.com/allyourcodebase/libressl#<refname>
1326
```
1427

15-
You can then import `libressl` in your `build.zig` with:
28+
You can then use `libressl` in your `build.zig` as follows:
1629

1730
```zig
1831
const libressl_dependency = b.dependency("libressl", .{
1932
.target = target,
2033
.optimize = optimize,
34+
.@"enable-asm" = true, // enable assembly routines on supported platforms
2135
});
22-
your_exe.linkLibrary(libressl_dependency.artifact("tls"));
36+
your_exe.linkLibrary(libressl_dependency.artifact("tls")); // or "ssl", or "crypto"
2337
```
38+
39+
## Version Support Matrix
40+
41+
| Refname | LibreSSL Version | Zig `0.12.x` | Zig `0.13.x` | Zig `0.14.0-dev` |
42+
|----------|------------------|--------------|--------------|------------------|
43+
| `3.9.2` | `3.9.2` ||||

0 commit comments

Comments
 (0)