The README file on the github project is mostly intended for developers as it contains all sorts of information regarding how to run tests, build packages, update documentations etc. I would like to see a dedicated README file for users that only want to run pip install splipy followed by creating a few geometries and extracting knot vectors and controlpoints. Should contain lots of specific examples.
The
READMEfile on the github project is mostly intended for developers as it contains all sorts of information regarding how to run tests, build packages, update documentations etc. I would like to see a dedicated README file for users that only want to runpip install splipyfollowed by creating a few geometries and extracting knot vectors and controlpoints. Should contain lots of specific examples.Details can be found here: https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi