cli icon indicating copy to clipboard operation
cli copied to clipboard

Add Nix(OS) support + `Revamp README.md`

Open TheBearodactyl opened this issue 11 months ago • 13 comments

TheBearodactyl avatar Jan 18 '25 23:01 TheBearodactyl

not a fan of install instructions in readme, theyre already in the docs

matcool avatar Jan 18 '25 23:01 matcool

any added documentation should probably be moved to the respective docs page and the readme should just be updated to refer to there for further instructions to keep these in a unified place

on top of this, I've only skimmed through the instructions, but I don't believe vi should be recommended to users, who are not expected to have prior experience with it, does macOS not have any other built-in text editor that would be more appropriate to recommend to the average developer?

Cvolton avatar Jan 19 '25 00:01 Cvolton

any added documentation should probably be moved to the respective docs page and the readme should just be updated to refer to there for further instructions to keep these in a unified place

on top of this, I've only skimmed through the instructions, but I don't believe vi should be recommended to users, who are not expected to have prior experience with it, does macOS not have any other built-in text editor that would be more appropriate to recommend to the average developer?

fair enough also idk i don't use mac.

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

I just searched it up and yeah i can edit it to use nano, would that work?

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

I just searched it up and yeah i can edit it to use nano, would that work?

why even include this in the first place? the docs has instructions already that are much shorter (just uses our brew tap)

matcool avatar Jan 19 '25 00:01 matcool

Ideally the README should point to the docs page that specifies how to install the CLI on all platforms.

Also I've seen that the nix stuff sets the CLI version as 0.1.0, shouldn't that be 3.4.0?

Fleeym avatar Jan 19 '25 00:01 Fleeym

no macos support in the nix file 💔

qimiko avatar Jan 19 '25 00:01 qimiko

no macos support in the nix file 💔

macos has nix??????

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

Ideally the README should point to the docs page that specifies how to install the CLI on all platforms.

Also I've seen that the nix stuff sets the CLI version as 0.1.0, shouldn't that be 3.4.0?

both are now fixed

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

macos has nix??????

it does! you'll have to add the apple_sdk frameworks to the build inputs (Security, AppKit, and SystemConfiguration)

also you should add the shell completion install step, you can access them with geode completions. not a big deal, but kinda nice to have

qimiko avatar Jan 19 '25 00:01 qimiko

macos has nix??????

it does! you'll have to add the apple_sdk frameworks to the build inputs (Security, AppKit, and SystemConfiguration)

also you should add the shell completion install step, you can access them with geode completions. not a big deal, but kinda nice to have

Oki :D

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

@Cvolton i did what you said and opened a pr to add NixOS install instructions

TheBearodactyl avatar Jan 19 '25 00:01 TheBearodactyl

@qimiko could you check and see if it works on Mac now? i don't have a Mac so i can't reliably test whether or not my edits worked or not

TheBearodactyl avatar Jan 19 '25 01:01 TheBearodactyl