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.

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.

cmd/ooniprobe/internal/bindata/bindata.go

@@ -1,5 +1,6 @@
 // Code generated by go-bindata. DO NOT EDIT.
 // sources:
+// data/README.md
 // data/default-config.json
 // data/migrations/1_create_msmt_results.sql
 // data/migrations/2_single_msmt_file.sql
@@ -80,6 +81,36 @@ func (fi bindataFileInfo) Sys() interface{} {
 	return nil
 }
 
+var _bindataDataREADMEMd = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x3c\xca\xb1\x0d\x02\x31\x0c\x05\xd0\x3e\x53\x7c\x89\x9a\xcb\x12\x8c\xc0\x02\x49\x6c\x91\x2f\xdd\xd9\x28\x76\x0a\xb6\x47\x34\xd4\xef\xdd\xf0\xe0\xd2\x91\xbe\x3e\x78\x31\xe7\xee\xc7\xf0\xab\xba\x1b\xeb\x7b\x79\xd7\xfb\x38\x59\xa5\x65\x2b\xe5\x39\x19\x90\x7f\x1f\x6e\xd9\x68\x81\x9f\x22\x67\x4b\x30\xa0\x57\x57\x11\x15\xd0\xd2\xd1\x37\x4f\x89\xa3\x7c\x03\x00\x00\xff\xff\x64\xbc\xf9\x0a\x67\x00\x00\x00")
+
+func bindataDataREADMEMdBytes() ([]byte, error) {
+	return bindataRead(
+		_bindataDataREADMEMd,
+		"data/README.md",
+	)
+}
+
+
+
+func bindataDataREADMEMd() (*asset, error) {
+	bytes, err := bindataDataREADMEMdBytes()
+	if err != nil {
+		return nil, err
+	}
+
+	info := bindataFileInfo{
+		name: "data/README.md",
+		size: 0,
+		md5checksum: "",
+		mode: os.FileMode(0),
+		modTime: time.Unix(0, 0),
+	}
+
+	a := &asset{bytes: bytes, info: info}
+
+	return a, nil
+}
+
 var _bindataDataDefaultconfigJson = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x54\x8d\x31\x0e\xc2\x30\x0c\x45\xf7\x9c\xc2\xca\xcc\x00\x6b\x2e\x63\x85\xe6\x97\x46\x4a\x9d\xca\x4e\xca\x80\x7a\x77\xd4\x08\x81\x58\x9f\xdf\xf3\x7f\x39\x22\xcf\x3b\xd4\x72\x15\x1f\xe8\x76\x19\x20\xcb\x5c\x75\x45\xe2\xa9\x8a\x41\x9a\x0f\x34\xc7\x62\x18\x57\x5b\xa2\x66\x79\xf8\x40\x67\x4d\xe4\xfb\x56\x6a\x4c\xac\xb0\x5e\x9a\xf9\x40\x4d\x3b\x1c\xd1\x31\x74\x41\x6b\xb0\xc1\x3f\xfe\x13\x77\xcb\x0d\xc6\x5d\x0b\x97\xbc\xe6\xf3\xff\xf5\x1b\xc4\xb4\x47\x99\x90\x7e\x81\x41\x12\x4f\x1a\x6d\x61\xc5\x56\xf5\x6f\xc4\x1d\xee\x1d\x00\x00\xff\xff\x5e\x8a\x1a\x13\xc6\x00\x00\x00")
 
 func bindataDataDefaultconfigJsonBytes() ([]byte, error) {
@@ -234,6 +265,7 @@ func AssetNames() []string {
 // _bindata is a table, holding each asset generator, mapped to its name.
 //
 var _bindata = map[string]func() (*asset, error){
+	"data/README.md":                            bindataDataREADMEMd,
 	"data/default-config.json":                  bindataDataDefaultconfigJson,
 	"data/migrations/1_create_msmt_results.sql": bindataDataMigrations1createmsmtresultsSql,
 	"data/migrations/2_single_msmt_file.sql":    bindataDataMigrations2singlemsmtfileSql,
@@ -292,6 +324,7 @@ type bintree struct {
 
 var _bintree = &bintree{Func: nil, Children: map[string]*bintree{
 	"data": {Func: nil, Children: map[string]*bintree{
+		"README.md": {Func: bindataDataREADMEMd, Children: map[string]*bintree{}},
 		"default-config.json": {Func: bindataDataDefaultconfigJson, Children: map[string]*bintree{}},
 		"migrations": {Func: nil, Children: map[string]*bintree{
 			"1_create_msmt_results.sql": {Func: bindataDataMigrations1createmsmtresultsSql, Children: map[string]*bintree{}},

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.