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

Improve documentation #46

Open
3 of 4 tasks
senderle opened this issue Oct 31, 2016 · 1 comment
Open
3 of 4 tasks

Improve documentation #46

senderle opened this issue Oct 31, 2016 · 1 comment

Comments

@senderle
Copy link
Owner

senderle commented Oct 31, 2016

This is a big issue with lots of potential sub-issues. Ideas:

  • Provide details about required metadata structure, viz. that the first column must be filenames, the filenames in the metadata must match the actual filenames exactly, but can be extended paths as long as the files are all in the same folder and the matches are exact.
  • Give more detailed help for the individual fields and options.
  • Add contextual information to the HTML output.
  • Duplicate and extend the existing (but stale and hard-to-find) documentation on the wiki branch. (And then delete that branch!)

Feel free to add to this list.

@senderle
Copy link
Owner Author

Related: #53

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