ooni-probe-cli/internal/libminiooni/README.md

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

This CLI has CLI options that do not conflict with Measurement Kit
v0.10.x CLI options. There are some options conflict with the legacy
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.

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.
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. 2021-02-03 16:54:00 +01:00			`# Package github.com/ooni/probe-cli/internal/libminiooni`
chore: merge probe-engine into probe-cli (#201) This is how I did it: 1. `git clone https://github.com/ooni/probe-engine internal/engine` 2. ``` (cd internal/engine && git describe --tags) v0.23.0 ``` 3. `nvim go.mod` (merging `go.mod` with `internal/engine/go.mod` 4. `rm -rf internal/.git internal/engine/go.{mod,sum}` 5. `git add internal/engine` 6. `find . -type f -name \*.go -exec sed -i 's@/ooni/probe-engine@/ooni/probe-cli/v3/internal/engine@g' {} \;` 7. `go build ./...` (passes) 8. `go test -race ./...` (temporary failure on RiseupVPN) 9. `go mod tidy` 10. this commit message Once this piece of work is done, we can build a new version of `ooniprobe` that is using `internal/engine` directly. We need to do more work to ensure all the other functionality in `probe-engine` (e.g. making mobile packages) are still WAI. Part of https://github.com/ooni/probe/issues/1335 2021-02-02 12:05:47 +01:00
			`Package libminiooni implements the cmd/miniooni CLI. Miniooni is our`
			`experimental client used for research and QA testing.`

			`This CLI has CLI options that do not conflict with Measurement Kit`
			`v0.10.x CLI options. There are some options conflict with the legacy`
			`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.`

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. 2021-02-03 16:54:00 +01:00			`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.`