c/ooni-probe-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc(Readme.md): minor refactoring (#444)

Browse Source
This commit is contained in:
Simone Basso 2021-08-20 13:18:39 +02:00 committed by GitHub
parent 4a9e76ec8a
commit c3bec9de2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Readme.md
View File

@ -1,30 +1,41 @@
# OONI Probe Client Library and CLI # OONI Probe Client Library and CLI
[![GoDoc](https://godoc.org/github.com/ooni/probe-cli?status.svg)](https://godoc.org/github.com/ooni/probe-cli) [![Short Tests Status](https://github.com/ooni/probe-cli/workflows/shorttests/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Ashorttests) [![All Tests Status](https://github.com/ooni/probe-cli/workflows/alltests/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Aalltests) [![Coverage Status](https://coveralls.io/repos/github/ooni/probe-cli/badge.svg?branch=master)](https://coveralls.io/github/ooni/probe-cli?branch=master) [![Go Report Card](https://goreportcard.com/badge/github.com/ooni/probe-cli)](https://goreportcard.com/report/github.com/ooni/probe-cli) [![linux-debian-packages](https://github.com/ooni/probe-cli/workflows/linux-debian-packages/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Alinux-debian-packages) [![GitHub issues by-label](https://img.shields.io/github/issues/ooni/probe/ooni/probe-cli?style=plastic)](https://github.com/ooni/probe/labels/ooni%2Fprobe-cli) * Documentation: [![GoDoc](https://godoc.org/github.com/ooni/probe-cli?status.svg)](https://godoc.org/github.com/ooni/probe-cli)
* `go test -race -short ./...` status: [![Short Tests Status](https://github.com/ooni/probe-cli/workflows/shorttests/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Ashorttests)
* `go test -race ./...` status: [![All Tests Status](https://github.com/ooni/probe-cli/workflows/alltests/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Aalltests)
* Code coverage for `-short` tests: [![Coverage Status](https://coveralls.io/repos/github/ooni/probe-cli/badge.svg?branch=master)](https://coveralls.io/github/ooni/probe-cli?branch=master)
* Go Report Card: [![Go Report Card](https://goreportcard.com/badge/github.com/ooni/probe-cli)](https://goreportcard.com/report/github.com/ooni/probe-cli)
* Debian package builds: [![linux-debian-packages](https://github.com/ooni/probe-cli/workflows/linux-debian-packages/badge.svg)](https://github.com/ooni/probe-cli/actions?query=workflow%3Alinux-debian-packages)
* Open issues: [![GitHub issues by-label](https://img.shields.io/github/issues/ooni/probe/ooni/probe-cli?style=plastic)](https://github.com/ooni/probe/labels/ooni%2Fprobe-cli)
The next generation OONI Probe: client library and Command Line Interface. The next generation OONI Probe: client library and Command Line Interface.
## User setup ## User setup
Please, follow the instructions at [ooni.org/install/cli](https://ooni.org/install/cli) Please, follow the instructions at [ooni.org/install/cli](https://ooni.org/install/cli)
to install `ooniprobe`. If we do not support your use case, please let us know. to install `ooniprobe`. If we do not support your use case, please let us know. Once
`ooniprobe` is installed, try `ooniprobe help` to get interactive help.
Once `ooniprobe` is installed, try `ooniprobe help` to get interactive help.
## Reporting issues ## Reporting issues
Please, report issues with this codebase at [github.com/ooni/probe]( Report issues at [github.com/ooni/probe](
https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone). https://github.com/ooni/probe/issues/new?labels=ooni/probe-cli&assignee=bassosimone).
Please, make sure you tag such issues using the `ooni/probe-cli` label. Please, make sure you add the `ooni/probe-cli` label.
## Repository organization ## Repository organization
Every top-level directory contains an explanatory README file. Every top-level directory contains an explanatory README file.
## OONIProbe ## ooniprobe
Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you Be sure you have golang >= 1.16 and a C compiler (Mingw-w64 for Windows). You
need Mingw-w64 installed). You can build using: can build using:
```bash ```bash
go build -v ./cmd/ooniprobe go build -v ./cmd/ooniprobe
@ -40,7 +51,7 @@ Make sure you have GNU make installed, then run:
./mk android ./mk android
``` ```
Builds bindings for Android. (Add `OONI_PSIPHON_TAGS=""` if you to build bindings for Android. (Add `OONI_PSIPHON_TAGS=""` if you
cannot clone private repositories in the https://github.com/ooni namespace.) cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) pushed to the Maven Central package The generated bindings are (manually) pushed to the Maven Central package
@ -55,7 +66,7 @@ Make sure you have GNU make installed, then run:
./mk ios ./mk ios
``` ```
Builds bindings for iOS. (Add `OONI_PSIPHON_TAGS=""` if you to build bindings for iOS. (Add `OONI_PSIPHON_TAGS=""` if you
cannot clone private repositories in the https://github.com/ooni namespace.) cannot clone private repositories in the https://github.com/ooni namespace.)
The generated bindings are (manually) added to GitHub releases. The instructions The generated bindings are (manually) added to GitHub releases. The instructions
@ -71,6 +82,12 @@ go build -v ./internal/cmd/miniooni
This will generate a binary called `miniooni` in the current directory. This will generate a binary called `miniooni` in the current directory.
## Specification
Every nettest (aka experiment) implemented in this repository has a companion
spec in the [ooni/spec](https://github.com/ooni/spec) repository.
## Updating dependencies ## Updating dependencies
```bash ```bash