peteboyd / lammps_interface

automatic generation of LAMMPS input files for molecular dynamics simulations of MOFs
MIT License
125 stars 63 forks source link

add documentation template #22

Closed ltalirz closed 4 years ago

ltalirz commented 4 years ago

@danieleongari mentioned he will read through the code over the weekend and would be happy to work on a documentation during this time

This adds

ltalirz commented 4 years ago

Thanks @peteboyd - after merging another PR with fixes, the documentation (still rather empty) is now available at https://lammps-interface.readthedocs.io

It would make sense to add you as a maintainer - for this simply register at readthedocs.org and let me know your username.

Any changes to the docs in the docs/ folder should be available on readthedocs.org within a few minutes delay.

Once @danieleongari has added more content, we can also add a link + badge to the README.