doc: ensure all top dirs have an explanatory README (#214)

* doc: ensure all top dirs have an explanatory README

This makes the repository a lil bit nicer to newcomers.

Part of https://github.com/ooni/probe/issues/1335

* fix: re-run bindata to embed the README

The readme is small, so we can pay the price of adding it.

On a related note, I am very pleased the Go team implemented the
`//go:embed` feature, so we can get rid of this bindata thing.
This commit is contained in:
Simone Basso
2021-02-03 16:54:00 +01:00
committed by GitHub
parent bfd19fd347
commit 31cf7d2fdf
11 changed files with 59 additions and 7 deletions
+3 -4
View File
@@ -1,4 +1,4 @@
# Package github.com/ooni/probe-engine/libminiooni
# Package github.com/ooni/probe-cli/internal/libminiooni
Package libminiooni implements the cmd/miniooni CLI. Miniooni is our
experimental client used for research and QA testing.
@@ -9,6 +9,5 @@ OONI Probe CLI options. Perfect backwards compatibility is not a
design goal for miniooni. Rather, we aim to have as little conflict
as possible such that we can run side by side QA checks.
We extracted this package from cmd/miniooni to allow us to further
integrate the miniooni CLI into other binaries (see for example the
code at github.com/bassosimone/aladdin).
This package was split off from cmd/miniooni in ooni/probe-engine. For
now we are keeping this split, but we will merge them in the future.