nix-community / flakelight

Framework for simplifying flake setup [maintainer=@accelbread]
MIT License
227 stars 5 forks source link

update readme w/ comparison to flake-parts #24

Closed rencire closed 1 month ago

rencire commented 1 month ago

Hi, I recently stumbled on this tool while searching for alternatives to flake-parts. I found this post on discourse that compares the difference between the tools.

I took the text and added it to readme since I think it could be helpful to refer to these differences when learning about the project.

Feel free to edit/suggest changes, thanks!

accelbread commented 1 month ago

I don't think this should be added to the readme. If theres strengths of flakelight that are missing, that can be added to the features list.

I feel that adding a comparison to another library to the readme sets the stage as if the library exists to compete with the the other, rather than to stand on its own. Its also something that is likely to go out of date as other libraries evolve, and is unlikely to be updated as that would require keeping up with flake-parts development. It could be also interpreted as antagonism towards flake-parts. As such, it doesn't feel correct to me to have this in the readme.

It is valuable information for someone evaluating the library though, which is why I made the discourse post. Perhaps we should just link the discourse page from the readme?

rencire commented 1 month ago

@accelbread Makes sense, agree with your thoughts. I updated the PR, thanks.

accelbread commented 1 month ago

Thanks! Could you run nix fmt? That'll fix the formatting check thats failing.

accelbread commented 1 month ago

Thanks!