I notice that the documentation in the files is a bit scarce (at least compared to the excellent math-comp style).
I'm also missing an overview of the library. I can click around, but it would be more convenient to have a small readme file describing what is where. Are there any plans for that?
Hi Bas, indeed there is not more documentation than (sometimes short) headers. The names of the files are self-descriptive otherwise. Do you have any specific questions which would help us understand what you need ?
Far from perfect, but I think a readme like the one for math-classes could be useful
it would be more convenient to have a small readme file describing what is where
We haven't done this so far because contents is still moving a bit from one file to another, and we also already foresee some changes in the near future. I guess we chose to improve the headers locally rather than maintaining a centralized documentation with our limited manpower. Yet following your remark we have added links to publications/slides/etc. in the readme. Some contain pictures that depict the library succinctly.
Last updated: Aug 19 2022 at 19:03 UTC