Skip to content

Commit b189f92

Browse files
committed
rename test step and update readme
1 parent 32982f8 commit b189f92

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
This is [libgit2](https://libgit2.org/) packaged using Zig's build system.
33
Currently only supports Windows and Linux targets.
44

5-
While libgit2 supports many different options for system dependencies, I've opted to use [MbedTLS](https://www.trustedfirmware.org/projects/mbed-tls/) on Linux for TLS, crypto, and certificate support. SSH support is optional, and is provided by [libssh2](https://libssh2.org/).
5+
While libgit2 supports many different options for system dependencies, I've opted to use [MbedTLS](https://www.trustedfirmware.org/projects/mbed-tls/) by default on Linux for TLS, crypto, and certificate support. You can replace MbedTLS with OpenSSL if you prefer. SSH support is optional, and is provided by [libssh2](https://libssh2.org/).
66
All other dependencies are bundled in the source tree and compiled statically.
77

88
## Usage
@@ -17,6 +17,7 @@ const libgit2_dep = b.dependency("libgit2", .{
1717
.target = target,
1818
.optimize = optimize,
1919
.@"enable-ssh" = true, // optional ssh support via libssh2
20+
.@"enable-openssl" = true, // use openssl instead of mbedtls
2021
});
2122
your_compile_step.linkLibrary(libgit_dep.artifact("git2"));
2223
```

build.zig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ pub fn build(b: *std.Build) !void {
362362
examples_step.dependOn(&example_run.step);
363363
}
364364

365-
const tests_step = b.step("run-tests", "Tests");
365+
const tests_step = b.step("test", "Run unit tests");
366366
{
367367
const tests = b.addTest(.{
368368
.root_source_file = b.path("tests/main.zig"),

0 commit comments

Comments
 (0)