Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Nix(OS) support + Revamp README.md #103

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

TheBearodactyl
Copy link
Contributor

No description provided.

@matcool
Copy link
Member

matcool commented Jan 18, 2025

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

flake.nix Outdated Show resolved Hide resolved
@Cvolton
Copy link
Member

Cvolton commented Jan 19, 2025

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?

@TheBearodactyl
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@matcool
Copy link
Member

matcool commented Jan 19, 2025

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)

@Fleeym
Copy link
Contributor

Fleeym commented Jan 19, 2025

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?

@qimiko
Copy link
Contributor

qimiko commented Jan 19, 2025

no macos support in the nix file 💔

@TheBearodactyl
Copy link
Contributor Author

no macos support in the nix file 💔

macos has nix??????

@TheBearodactyl
Copy link
Contributor Author

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

@qimiko
Copy link
Contributor

qimiko commented Jan 19, 2025

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

@TheBearodactyl
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@TheBearodactyl
Copy link
Contributor Author

@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

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.

5 participants