From 4e5f9bd25464ce25ce31bbba659089b7a5fd7857 Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Sat, 5 Feb 2022 12:24:10 +0100 Subject: [PATCH] fix(Readme.md): clarify what is the internal/engine pkg One may otherwise wonder why there are some package still inside the `internal/engine` package. This is a long running refactoring started when we merged `probe-engine` into this package and it will eventually be done :-). --- Readme.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index 6b7086d..ae683a5 100644 --- a/Readme.md +++ b/Readme.md @@ -16,7 +16,11 @@ This repository contains core OONI tools written in Go: - and all the related support packages (inside [internal](internal)). -Every top-level directory in this repository contains an explanatory README file. +Every top-level directory in this repository contains an explanatory README file. You +may also notice that some internal packages live under [internal/engine](internal/engine) +while most others are top-level. This is part of a long-standing refactoring started +when we merged https://github.com/ooni/probe-engine into this repository. We'll slowly +ensure that all packages inside `engine` are moved out of it and inside `internal`. ## License