winboat icon indicating copy to clipboard operation
winboat copied to clipboard

Add nix install instructions to README.md

Open realitymolder opened this issue 2 months ago • 12 comments

I've noticed the new flake.nix is missing installation instructions in the README so I've added a small section.

realitymolder avatar Sep 23 '25 16:09 realitymolder

Hey, I'll gladly merge once you folks figure out what are the best instructions, I see some comments suggesting improvements. I'm personally not on Nix.

TibixDev avatar Sep 25 '25 00:09 TibixDev

I was going to add this but since you already did it, bump!

lonyelon avatar Oct 14 '25 08:10 lonyelon

Winboat is now part of unstable. see https://github.com/NixOS/nixpkgs/pull/451068

instructions at https://github.com/TibixDev/winboat/pull/281#issuecomment-3436546594

sacrosanctic avatar Oct 29 '25 01:10 sacrosanctic

Will update this PR tomorrow.

realitymolder avatar Oct 29 '25 02:10 realitymolder

any updates? the nix flake has been removed from WinBoat's repo - I assume the instructions in the readme will reflect this?

waffles-dev avatar Oct 31 '25 16:10 waffles-dev

Will update this PR tomorrow.

Mother of god, time flies. Doing it now.

realitymolder avatar Nov 09 '25 19:11 realitymolder

@Etmix ready to merge :)

realitymolder avatar Nov 09 '25 19:11 realitymolder

@realitymolder sorry to nit pick, your instructions are factually correct, but only until 2025-11-23, at that point NixOS 25.11 will branch off from NixOS-unstable, and at that point you are able to use either nixos-unstable or nixos-25.11. nixos-25.11 is planned to officially be released on 2025-11-30, but the branch-off meaning the branch you can add as your input is planned to happen on the 23rd.

If this PR is merged today, it will only be correct for 13 days.

What I suggest is merge this today, and open a new PR today to include 25.11 in the instructions, and then merge the new PR at earliest 23rd, latest 30th.

:+1: But this PR LGTM

sigboe avatar Nov 10 '25 12:11 sigboe

@realitymolder sorry to nit pick, your instructions are factually correct, but only until 2025-11-23, at that point NixOS 25.11 will branch off from NixOS-unstable, and at that point you are able to use either nixos-unstable or nixos-25.11. nixos-25.11 is planned to officially be released on 2025-11-30, but the branch-off meaning the branch you can add as your input is planned to happen on the 23rd.

If this PR is merged today, it will only be correct for 13 days.

What I suggest is merge this today, and open a new PR today to include 25.11 in the instructions, and then merge the new PR at earliest 23rd, latest 30th.

👍 But this PR LGTM

Hey I did take that into consideration, and your suggestion is valid :) The original PR was two months ago, we will remove that note when unstable will be merged to 25.11+.

realitymolder avatar Nov 10 '25 12:11 realitymolder

Should a mention be added to warn that virtualisation.docker.rootless needs to be disabled? #171 Otherwise looks good to me

Etmix avatar Nov 12 '25 08:11 Etmix

Hey, we're in a code freeze at the moment until after 0.9.0. Hopefully it's out very soon. It will bring podman support - does that affect the nix stuff at all?

waffles-dev avatar Nov 12 '25 14:11 waffles-dev

Should a mention be added to warn that virtualisation.docker.rootless needs to be disabled? #171 Otherwise looks good to me

Yes, that is a good idea, I can edit that. But I wonder if podman (probably rootless) will change that (?)

Hey, we're in a code freeze at the moment until after 0.9.0. Hopefully it's out very soon. It will bring podman support - does that affect the nix stuff at all?

Hey, I guess we can edit that when it's out. Not sure if you prefer that to when the new version is out already or you prefer to halt this PR until then.

realitymolder avatar Nov 12 '25 15:11 realitymolder