This is very far from perfect, but it lays some groundwork to Tidepool
documentation. This follows my (very limited) understanding, and so is
very much incomplete and WIP. I would like some help with the concepts I
haven't quite understood <3

@@ -0,0 +9,4 @@
+to build all other basic Linux utilities, and are often
+transitive dependencies of higher-level packages.
+
+The goal of `foundation` is to build `glibc`. For this, a

@@ -29,0 +32,4 @@
+To build a package, you can run the following command inside of the `tidepool` directory:
+
+```console
+nix build -f . packages.foundation.bash.latest

@@ -29,0 +35,4 @@
+nix build -f . packages.foundation.bash.latest
+```
+
+If you want to use the flake calling convention, you would have to add `package` attribute:

@@ -29,0 +49,4 @@
+This attrpath sets up default platforms for you. You can also set platforms explicitly, with this syntax:
+
+```console
+nix build .#packages.foundation.gcc.latest.packages.<build>.<host>.<target>.package

@@ -29,0 +70,4 @@
+
+## Development
+
+Tidepool is built with Aux's portable submodules. They function similarly to NixOS modules.

@@ -29,0 +73,4 @@
+Tidepool is built with Aux's portable submodules. They function similarly to NixOS modules.
+Using the submodules, Tidepool provides a nice and easy-to-work-with API.
+
+Tidepool can be used with flakes or without them (using [npins](https://github.com/andir/npins)).

@@ -29,0 +75,4 @@
+
+Tidepool can be used with flakes or without them (using [npins](https://github.com/andir/npins)).
+Tidepool exports an attribute set, which can be viewed using `nix repl`. Let's visualize
+it using `nix flake show` and see what is there!

@@ -29,0 +129,4 @@
+
+- `internal` - this is the internal attribute set. Currently, it only brings Tidepool's
+dependencies into scope: more concretely, it exposes the `foundation` namespace from
+a confusingly-named [Foundation](https://git.auxolotl.org/auxolotl/foundation) repository,

@@ -29,0 +131,4 @@
+dependencies into scope: more concretely, it exposes the `foundation` namespace from
+a confusingly-named [Foundation](https://git.auxolotl.org/auxolotl/foundation) repository,
+which does the bootstrap chain from a 357-byte file
+- `new` - this is a function that allows to create a new package set, independent

@@ -29,0 +149,4 @@
+  tidepool.new module;
+```
+
+- `preferences` - this is an attribute set that lists your current preferences.

@@ -0,0 +4,4 @@
+
+## Foundation
+
+`foundation` is a package set similar to Nixpkgs' `stdenv`.

@@ -0,0 +9,4 @@
+to build all other basic Linux utilities, and are often
+transitive dependencies of higher-level packages.
+
+The goal of `foundation` is to build a GNU C toolchain.

@@ -0,0 +25,4 @@
+Neat!
+
+The bootstrap chain is based on [full-source](https://guix.gnu.org/en/blog/2023/the-full-source-bootstrap-building-from-source-all-the-way-down/)
+bootstrap, made possible with amazing work by Guix's people!

@@ -0,0 +33,4 @@
+To build stage1 (`i686-linux`), run:
+
+```console
+nix build --system i686-linux .#packages.foundation.glibc.versions."2.38-stage1-passthrough".package

@@ -0,0 +57,4 @@
+It's worth discussing this in more depth, because it demonstrates a couple of
+more advanced features.
+
+`context` is a special option that announces information that is needed to

@@ -0,0 +60,4 @@
+`context` is a special option that announces information that is needed to
+use the package as a dependency. For example, to use a C dependency, you
+would need to tell the compiler where to look for relevant headers by appending
+a flag. The C dependency can have `context` defined which includes the necessary

@@ -29,0 +32,4 @@
+To build a package, you can run the following command inside of the `tidepool` directory:
+
+```console
+nix build -f . packages.foundation.bash.latest.packages.x86_64-linux.x86_64-linux.x86_64-linux.package

@@ -29,0 +46,4 @@
+The full command syntax looks like this:
+
+```console
+nix build .#packages.<package set>.<package>.<version>.packages.<build>.<host>.<target>.package

@@ -29,0 +49,4 @@
+nix build .#packages.<package set>.<package>.<version>.packages.<build>.<host>.<target>.package
+```
+
+It allows you to specify many things! For example, you can specify the package version:

@@ -29,0 +89,4 @@
+We can visualize it!
+
+```console
+git+file:///home/nixchad/Documents/Projects/labs?dir=tidepool

@@ -29,0 +108,4 @@
+│       ├───...
+│       └───zlib omitted (use '--all-systems' to show)
+└───preferences: unknown
+```

@@ -0,0 +4,4 @@
+
+## Foundation
+
+`foundation` is a minimal package set to start building everything else.