packages/readme: clarify roles of packages.foundation and packages.core

This commit is contained in:
whispers 2026-01-04 12:05:15 -05:00
parent b226ca0968
commit 1c26dd089b
Signed by: whispers
SSH key fingerprint: SHA256:qaPOnPCEzUjz7LzekvtosQQ8eiI7K6TbUi7hwrniT3o

View file

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