Better README/docs
Opened this issue · 0 comments
sherpal commented
The README is a mess. It has too many things in it and it does not follow good readme practices, such as
- start by a motivation
- follow up with the minimum amount of info to have the library working
- list/discuss alternatives
- link to more in-depth documentation.
For this one, it might be interesting to have an external set of eyes since it's probably easier for to spot the difficulties to hightlight in such docs.