search

coq-community / coq-nix-toolbox

Nix helper scripts to automate local builds and CI [maintainers=@CohenCyril,@Zimmi48]
MIT License
32 stars 9 forks source link

proposal for an executive summary #226

Closed affeldt-aist closed 1 month ago

affeldt-aist commented 2 months ago

Hi,

We are relying on the coq-nix-toolbox for a formalization of analysis on top of MathComp. I do not understand the inner working of the coq-nix-toolbox but I occasionally have to check the README, and, every time, I have the feeling that the purpose is hard to grasp by a casual user. I therefore propose to add an executive summary at the top of the README. It is certainly not accurate but I believe that it could help outisders and maybe trigger the addition of further explanations about the Nix keywords by people more knowledgeable than me.

Co-authored-by: @proux01

Zimmi48 commented 1 month ago

Thanks for writing this summary! I've added my own improvements on top.

proux01 commented 1 month ago

Thanks, let's merge then