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

* doc: ensure all top dirs have an explanatory README

This makes the repository a lil bit nicer to newcomers.

Part of ooni/probe#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.

MOBILE/README.md

@@ -1,3 +1,3 @@
-# Directory github.com/ooni/probe-engine/MOBILE
+# Directory github.com/ooni/probe-cli/MOBILE
 
 This directory is used for building for Android and iOS.

QA/README.md

@@ -11,7 +11,7 @@ Tools with this shallow-compatible CLI are:
 
 1. `github.com/ooni/probe-legacy`
 2. `github.com/measurement-kit/measurement-kit/src/measurement_kit`
-3. `github.com/ooni/probe-engine/cmd/miniooni`
+3. `github.com/ooni/probe-engine/internal/cmd/miniooni`
 
 ## Run QA on a Linux system
 

cmd/README.md

@@ -0,0 +1,4 @@
+# Directory github.com/ooni/probe-cli/cmd
+
+This directory contains the public binaries that you
+can build from this repository.

data/README.md

@@ -0,0 +1,3 @@
+# Directory github.com/ooni/probe-cli/data
+
+This directory contains data that is embedded into builds.

debian/README.md

@@ -0,0 +1,3 @@
+# Directory github.com/ooni/probe-cli/debian
+
+This directory allows us to build debian packages.

docs/README.md

@@ -0,0 +1,3 @@
+# Directory github.com/ooni/probe-cli/docs
+
+This directory contains documentation.

internal/README.md

@@ -0,0 +1,3 @@
+# Directory github.com/ooni/probe-cli/internal
+
+This directory contains private Go packages.

internal/cmd/README.md

@@ -1,4 +1,5 @@
 # Directory github.com/ooni/probe-cli/internal/cmd
 
 This directory contains the source code for the CLI tools we build
-but we don't want to expose to the outside world.
+but we don't want to expose to the outside world. That is, you
+can only build these tools if you have cloned this repo.

internal/libminiooni/README.md

@@ -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.

pkg/README.md

@@ -0,0 +1,3 @@
+# Directory github.com/ooni/probe-cli/pkg
+
+This directory contains public Go packages.