+---------------------------+
                |                           |
                |         LIBKOOKIE         |
                |                           |
                +---------------------------+

My personal NixOS fork, with custom modules, build system, and
workflow configuration.

The only dependency to this project is Nix installed on your system,
with a working stdenv.  Check ./stage1 to see how to build the
libkookie build tools (s1build).


Structure
---------

This repository contains a subtree of nixpkgs, overlays, a set of
custom modules making up the core of libkookie, and configuration sets
for different workflows.

The entry point to a configuration is stored in ./roots, sorted by
machine name.

- config: applying custom modules for various workflows
- ext: possible private extensions
- modules: custom configuration modules
- nixpkgs: subtree of nixpkgs (follows unstable)
- overlays/kookie: custom out-of-nixpkgs packages
- overlays/patches: patches to upstream packages
- ovrelays/staging: packages that aren't part of upstream yet
- roots: available entry-points (machines)


How to build
------------

You can either install s1build on your system globally, or build it on
the fly by calling stage1/build.  By default the build tool will take
the return of hostname(1) to be the selected root.  If you want to
override that behaviour you can provide a root via the cli.


Contribute
----------

While this repo is also sometimes mirrored on GitHub, the main tree
lives on my cgit (https://git.spacekookie.de/libkookie).  To
contribute patches to this project, please send me an e-mail, either
directly [1], or to my public-inbox [2].

[1]: kookie@spacekookie.de
[2]: https://lists.sr.ht/~spacekookie/public-inbox


License
-------

The nixpkgs subtree, as well as the package overlays are licensed
under the MIT public license for the best compatibility with upstream
NixOS.  My custom modules, configs, and device roots are licensed
under the GNU Public License 3.0 (or later).