From 1c26dd089b9190590ccd6f4189bd05748d7b3efb Mon Sep 17 00:00:00 2001 From: whispers Date: Sun, 4 Jan 2026 12:05:15 -0500 Subject: [PATCH] packages/readme: clarify roles of packages.foundation and packages.core --- tidepool/src/packages/README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/tidepool/src/packages/README.md b/tidepool/src/packages/README.md index a652ff2..24464c2 100644 --- a/tidepool/src/packages/README.md +++ b/tidepool/src/packages/README.md @@ -24,11 +24,26 @@ binaries to point to our dependencies. This "unbreaks" proprietary binaries by making them point to Tidepool-provided dependencies. Neat! -The `foundation` package set builds upon and uses packages from [Foundation](https://git.auxolotl.org/auxolotl/foundation), -our early bootstrap chain. It augments the packages from Foundation with +The `foundation` package set builds upon and uses packages from [Foundation], +our early bootstrap chain. Since Aux Foundation only provides for +single-platform native builds, it augments the packages from Foundation with Tidepool's cross-compilation capabilities, and adds additional flags to compilers to better support our use case. +The packages in `foundation` are not intended for end user usage. They do not +integrate with the full scope of Tidepool's machinery, and provide no more than +necessary to bootstrap a cross-platform package set. + +[Foundation]: https://git.auxolotl.org/auxolotl/foundation + +## Core + +`core`, and potentially other future namespaces, contains packages that +maximally integrate with the rest of Tidepool and are intended for end users. +This will include the "final" versions of the packages in the `foundation` +namespace as well as a wide variety of other tools. See +[`core/README.md`](core/README.md) for some further context. + ## Aux `aux`, at this time, is a trivial package set that demonstrates