Cleanup documentation

[ryanwarsaw]

Just need to tidy it up a bit, hopefully make things much easier for new contributors. Perhaps tie in some basic information about the DSO project with project-specific documentation on Jisort.

I'd also like to focus more on the customization options that this app provides, I think that is one of the key factors that would make this an attractive option for future research projects, etc.

[ryanwarsaw]

cc: @acabunoc (I'm curious if you have any thoughts on how the end product should be shipped?)

[abbycabs]

Hey! How the documentation should be shipped?

At minimum:

• README needs to be updated (no more "Description goes here" -- have an actual description)
• Add CONTRIBUTING.md in the root directory, link to it from the README
• Add a code of conduct that is linked from both the README and CONTRIBUTING.md

Basically, follow the guidelines from the Open Leadership Training Series

[ryanwarsaw]

@acabunoc Helpful, but I meant more as in should it just be shipped directly as markdown files, should we use Github's wiki functionality, or use a 3rd party solution like https://www.gitbook.com/ or https://readthedocs.org/. Or even a hybrid solution consisting of multiple options.

[abbycabs]

For the files I mentioned above, they should be directly in the repo (markdown) -- if you additional docs, you can decide where they live! As long as it's clear in the repo where to look.

[ryanwarsaw]

See #237