c/ooni-probe-cli
Watch
1
0
Fork
You've already forked ooni-probe-cli
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

cleanup: chmod -x mk && mv mk Makefile (#863)

Browse source 
While there, document what we need to document without mentioning too
many details about release builds, for which we have the Makefile.

See https://github.com/ooni/probe/issues/2218.
This commit is contained in:
Simone Basso 2022-08-17 13:46:41 +02:00 • committed by GitHub
commit 2083edb258
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 57 additions and 86 deletions
Download patch file Download diff file Expand all files Collapse all files

47
Readme.md
View file

@ -14,7 +14,7 @@ This repository contains core OONI tools written in Go:
- the mobile library ([pkg/oonimkall](pkg/oonimkall));
- and all the related support packages (inside [internal](internal)).
- the OONI Probe engine (inside [internal](internal)).
Every top-level directory in this repository contains an explanatory README file. You
may also notice that some internal packages live under [internal/engine](internal/engine)
@ -51,52 +51,25 @@ Please, make sure you add the `ooni/probe-cli` label.
## Build instructions
Be sure you have the golang version mentioned inside the [GOVERSION](GOVERSION)
file and a C compiler (Mingw-w64 for Windows).
### ooniprobe
Be sure you have the golang version mentioned inside the [GOVERSION](GOVERSION)
file and a C compiler (Mingw-w64 for Windows). You can build using:
Ooniprobe is the official CLI client. Compile using:
```bash
go build -v ./cmd/ooniprobe
go build -v -ldflags "-s -w" ./cmd/ooniprobe
```
This will generate a binary called `ooniprobe` in the current directory.
### Android bindings
Make sure you have GNU make installed, then run:
```bash
./mk ./MOBILE/android
```
to build bindings for Android. (Add `OONI_PSIPHON_TAGS=""` if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) pushed to the Maven Central package
repository. The instructions explaining how to integrate these bindings
are published along with the release notes.
### iOS bindings
Make sure you have GNU make installed, then run:
```bash
./mk ./MOBILE/ios
```
to build bindings for iOS. (Add `OONI_PSIPHON_TAGS=""` if you
cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) added to GitHub releases. The instructions
explaining how to integrate these bindings are published along with the release notes.
### miniooni
Miniooni is the experimental OONI client used for research. Compile using:
```bash
go build -v ./internal/cmd/miniooni
go build -v -ldflags "-s -w" ./internal/cmd/miniooni
```
This will generate a binary called `miniooni` in the current directory.
@ -106,7 +79,7 @@ This will generate a binary called `miniooni` in the current directory.
Oohelperd is the test helper server. Compile using:
```bash
go build -v ./internal/cmd/oohelperd
go build -v -ldflags "-s -w" ./internal/cmd/oohelperd
```
This will generate a binary called `oohelperd` in the current directory.
@ -132,5 +105,5 @@ Create an issue according to [the routine release template](
https://github.com/ooni/probe/blob/master/.github/ISSUE_TEMPLATE/routine-sprint-releases.md)
and perform any item inside the check-list.
We build releases using `./mk`, which requires GNU make. Try
the `./mk help|less` command for detailed usage.
We build releases using [Makefile](Makefile), which requires GNU make. Try
the `make help|less` command for detailed usage.