Information presented in README.md front page

dstansby / pfsspy

Potential Field Source Surface model package for Python

https://pfsspy.readthedocs.io/

Other

41 stars 17 forks source link

Information presented in README.md front page #238

Closed sibirrer closed 3 years ago

sibirrer commented 3 years ago

Description

The readthedocs front page is well designed with all relevant information. The GitHub front page as rendered from the README.md file is very minimal, does not provide information for the installation and/or documentation link. I suggest having more information upfront on the GitHub page helps the users navigate to the documentation and installation.

This issue is a non-essential suggestion as part of my JOSS review.

dstansby commented 3 years ago

I've added a link to the full documentation in the README file in the PR referenced above.