Skip to content

Flake Documentation - #308

Open
Immabed wants to merge 9 commits into
shibco:mainfrom
Immabed:docs/flake
Open

Immabed wants to merge 9 commits into
shibco:mainfrom
Immabed:docs/flake

Conversation

@Immabed

@Immabed Immabed commented Sep 10, 2026

Copy link
Copy Markdown

Basic documentation for the nix flake. I put the documentation in a separate file, FLAKE.md in the main directory, to not clutter the README.

In two locations in the README I direct NixOS/flake users to the flake documentation.

Nix-heads who are smarter than me: Have I screwed up any terminology? Does it make sense? I use .#flake-name a few times, is the . a proper way to reference the flake in this usage, or should I just use #flake-name?

If I get a few thumbs up from nix users, I'll mark this for review.

Flake documentions in its own file, so as not to scare the normies.
+ Installation instructions
+ System package details
+ Running Live, installing plugins, etc.
+ Other flakes and options
+ Sample system config

Couple of links to the flake documentation in the README,
* Push NixOS users to FLAKE.md in the Installation section
* Push Flake users to the appropriate section in FLAKE.md for installing
  vsts
@LennartMeer

Copy link
Copy Markdown

Thank you so much for this!
While setting this up on my NixOS system i noticed the auto theme detection was not working for me. I traced it back to gdbus and strings not being available in PATH by default on NixOS.
Adding glib and binutils to the environment.systemPackages fixed it for me. Might be a nice hint to add to the documentation.

@Immabed

Immabed commented Sep 10, 2026

Copy link
Copy Markdown
Author

@LennartMeer good catch, you should open an issue with the details you can provide! Only planning on documentation in this PR, so an issue would ensure the bug is properly documented. It may be worth adding glib and binutils to the flake directly rather than relying on the user to install them.

r3quisitevariety and others added 6 commits September 10, 2026 17:41
Updated wording for clarity and corrected typos in FLAKE.md.
Fixes a couple typos.
Adjusts wording to clarify meaning.
Fix claim that every commit will cause a rebuild of wine, this is not
true, Nix is smarter than that.
Replaced instances of `.#` with `#` in documentation, based on V33's
feedback.
Replaced instances of `nix run .#` with `nix run
github:shibco/ableton-linux` for consistency, despite the bulkiness.
@Immabed

Immabed commented Sep 11, 2026

Copy link
Copy Markdown
Author

Thanks to @Version33 for pontificating on nix vocabulary, and especially @r3quisitevariety for reviewing and refining the docs. I've tested all the commands excepting the Realtime flake option, and am fairly confident in the accuracy of this documentation. Ready for review.

@Immabed
Immabed marked this pull request as ready for review September 11, 2026 01:07

@fernwick fernwick left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a few spelling/grammar improvements

Comment thread README.md Outdated
Comment thread FLAKE.md Outdated
Comment thread FLAKE.md Outdated
Co-authored-by: fernwick <229844000+fernwick@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants