Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User facing documentation #12

Open
andreww opened this issue Jun 30, 2017 · 0 comments
Open

User facing documentation #12

andreww opened this issue Jun 30, 2017 · 0 comments

Comments

@andreww
Copy link
Owner

andreww commented Jun 30, 2017

Could you add some documentation to a directory called /docs. If these are formatted in markdown it would be easy to host these using github pages, and readthedocs also knows how to display markdown.

The basic documentation ought to include:

  • A short outline of what pyDis does.
  • Some words on installation.
  • Details of the input file format and any command line options for _pn_control.py, _atomic_control.py, _segregation_control.py, etc. I think for this I would have a short general overview of the format, then a list of options for each file type.

There are probably more things to add, but getting this started will help. I'll add anything else I think of below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant