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

Add user documentation #17

Open
4 tasks
glesica opened this issue Nov 21, 2019 · 0 comments
Open
4 tasks

Add user documentation #17

glesica opened this issue Nov 21, 2019 · 0 comments

Comments

@glesica
Copy link
Collaborator

glesica commented Nov 21, 2019

It would be nice to add some documentation around how to actually use the tool. Presumably most of the users will be familiar with the major concepts, but it might be good to provide a very lightweight intro there as well for those who are less familiar (e.g. students). Additionally, documenting the command line flags should be table stakes here.

  • Usage instructions
  • Explanation of command line options / flags
  • Description of the algorithm (very basic) with a link to more information
  • Example usages using the example input files

Note that there is some existing documentation in the README file (in the NINJA subdirectory) but it appears to be somewhat outdated.

Put a separate README in the examples directory that explains what they are and how to run them and what the output should look like (in general terms)

@glesica glesica added this to the 1.0.0 Release milestone Nov 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant