From dea2d217f3b3b0d14433e541b7c6ee51dfb779c1 Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Mon, 9 Mar 2020 20:17:20 +0100 Subject: [PATCH] README.md: document how to build miniooni (#398) Part of https://github.com/ooni/probe-engine/issues/384. While there, document the mobile API. --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 457a649d..c1573bd2 100644 --- a/README.md +++ b/README.md @@ -26,17 +26,32 @@ miniooni CLI will be stable over time. This software uses [Go modules](https://github.com/golang/go/wiki/Modules) and requires Go v1.13+. We also depend on [Measurement Kit]( https://github.com/measurement-kit/measurement-kit), a C++14 library -implementing many OONI tests. +implementing many OONI tests, a.k.a. MK. Note that passing the `-tags nomk` flag to Go will disable linking Measurement Kit into the resulting Go binaries. You may want that in cases where you only want to use experiments written in Go. We plan on gradually rewriting all OONI tests in Go, therefore the -dependency on Measurement Kit will eventually be removed. +dependency on Measurement Kit will eventually be removed. A future version +of this document will provide platform specific instructions for +installing Measurement Kit and linking to it. -A future version of this document will provide platform specific -instruction for installing Measurement Kit and building. +## Building miniooni + +``` +go build -v -tags nomk ./cmd/miniooni/ +``` + +Omit `-tags nomk` to link with MK. + +## Building Android bindings + +``` +./build-android.bash +``` + +When building Android bindings, we automatically omit linking with MK. ## Release procedure