Skip to content
New issue

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

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

Already on GitHub? # to your account

doc: fix simple flake example #3083

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

elythh
Copy link
Contributor

@elythh elythh commented Mar 19, 2025

Replace the incorrect simple flake example from the README with a simpler one

@elythh elythh force-pushed the readme-flake-example branch from 958999e to 574855e Compare March 19, 2025 16:39
@elythh elythh changed the title fix(README): simple flake example doc: fix simple flake example Mar 19, 2025
@elythh
Copy link
Contributor Author

elythh commented Mar 19, 2025

Something similar could also be used for the template

Copy link
Member

@MattSturgeon MattSturgeon left a comment

Choose a reason for hiding this comment

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

Looks good overall. Thanks!

FYI: your branch is ~27 commits behind the latest main. You may want to fetch our repo (probably your upstream remote), rebase onto it and force-push.

Also, could you change your commit message to something like readme: fix & simplify simple flake example ? We usually use the rough file/directory to scope our commit messages.

nvim = nixvim'.makeNixvim config;
in {
packages = {
forAllSystems = fn: nixpkgs.lib.genAttrs systems fn;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
forAllSystems = fn: nixpkgs.lib.genAttrs systems fn;
forAllSystems = nixpkgs.lib.genAttrs systems;


inputs.nixvim.url = "github:nix-community/nixvim";
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
Copy link
Member

Choose a reason for hiding this comment

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

It may be better for us to suggest users use nixpkgs.follows = "nixvim/nixpkgs", at least for a flake that is just outputting nixvim packages and not also nixos configurations (etc):

Suggested change
nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
nixpkgs.follows = "nixvim/nixpkgs";

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants