softmaterialslab / nanoconfinement-md

This code allows users to simulate ions confined between material surfaces that are nanometers apart, and extract the associated ionic structure.
Apache License 2.0
5 stars 13 forks source link

documentation #43

Closed jadhao closed 6 years ago

jadhao commented 6 years ago

@smarru @kadupitiya I think now we should start documenting the manual of app development on nanohub based on what we learned from this experience. It should give the essential steps, be precise, concise, but has the details that enable other node members to realize the code-to-app transition pathway.

smarru commented 6 years ago

@jadhao do you have a preference on if this nanohub documentation should live within this tool or at a meta level example: softmaterialslab.github.io ?

jadhao commented 6 years ago

@smarru at this point, within this tool is fine; we will move it upstairs once it becomes a more general blueprint for a typical code to app transition. writing it now specific to this tool may be easier as it is fresh and the steps will flow smoothly

smarru commented 6 years ago

@jadhao let me know what you think of a sample documentation: The source of it - https://github.com/smarru/nanoconfinement-md/blob/master/docs/index.md Example link to share externally - https://smarru.github.io/nanoconfinement-md/

If you like these examples, I can send a PR to main repo and continue to add nanohub specific instructions

jadhao commented 6 years ago

@kadupitiya @smarru @foxsden we have the documentation; so I am closing this. the doc will remain live for future updates.