libAtoms / matscipy

Materials science with Python at the atomic-scale
http://libatoms.github.io/matscipy/
GNU Lesser General Public License v2.1
188 stars 55 forks source link

Updated README #128

Closed prs513rosewood closed 1 year ago

prs513rosewood commented 1 year ago

I updated the build instructions. I also went ahead and added some things that JOSS requires (e.g. help section, how to contribute). Feel free to edit before merging.

As a sidenote, from my experience with JOSS, I think we might need to write some documentation on the capabilities of matscipy, with examples. API documentation is necessary but not sufficient.