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.

Sign up for GitHub

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

Jump to bottom

Documentation #6

Open
jpalmer opened this issue May 31, 2016 · 0 comments
Open

Documentation #6

jpalmer opened this issue May 31, 2016 · 0 comments

Comments

@jpalmer
Copy link
Collaborator

jpalmer commented May 31, 2016

So currently the documentation is pretty poor.

I think we need two types of documentation.

  1. The wiki - the output stuff is already pretty well specified (although some info on the actual things you can output would be good). It would be good to get some more of this type of high level stuff. I think basically the wiki articles should be mainly for people who are only modifying the config file.
  2. Comments/doxygen Some of this is done but more would be good. This should provide some more detailed information than the wiki, for people who are actually modifying the code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jpalmer