mbuild icon indicating copy to clipboard operation
mbuild copied to clipboard

Published 20 hours ago • verified publisher icon mosdef-hub

Tutorials/examples/documentation

Open chrisiacovella opened this issue 4 years ago • 2 comments

Make it clearer the purpose/role of tutorials, example workflows, and documentation, especially in the context of "how to get started." @bdice had some thoughts on how he restructured the hoomd page to better convey this.

chrisiacovella avatar Mar 04 '20 16:03 chrisiacovella

A few thoughts:

  • Start from the top down. Focus on improving READMEs and homepages first.
  • I recommend a "Resources" section in the README (and mirrored on the front page of the docs) to help new users immediately find what websites/chat rooms/examples/documentation pages exist. See freud's docs for an example.
  • The awesome-readme repo has a list of other awesome READMEs.

bdice avatar Mar 04 '20 17:03 bdice

Here are GOMC-MoSDeF videos we made and posted on the GOMC Github page (https://github.com/GOMC-WSU/GOMC-MoSDeF). We can direct copy this to the MoSDeF page/GitHub somewhere, but we just need to know where, or feel free to download and copy.

Note: the YouTube videos are only available thru the links, but I will open them to be searchable soon.

6 video playlist link: https://www.youtube.com/playlist?list=PLdxD0z6HRx8Y9VhwcODxAHNQBBJDRvxMf

bc118 avatar Apr 28 '21 14:04 bc118