Option to include README in jar

[stevedlawrence]

Since we often distribute schemas as jars, it would be useful to include the README as well, since this file usually includes helpful things like usage and license information, which isn't necessarily in the schema files.

[stevedlawrence]

We should also include LICENSE/NOTICE files if they exist.

[olabusayoT]

I wonder if we can also add build.sbt, since all of our schema projects rely on it.

[stevedlawrence]

Possibly, though the layout of a jar is different than an SBT project. For example, it does not have a src/main/resources directory. So it isn't necessarily as simple as unziping a jar and running sbt, my guess is that isn't going to work. Note that we would also need to include plugins.bt since many build.sbt files rely on multiple plugins. More thought is probably needed to figure out how convert a jar to a buildable SBT project, or if another approach is needed (i.e. deliver the source repo with certain source/test files removed if necessary).

[mbeckerle]

If one adds a src/main/resources/doc directory with files in it, are those going to end up in a doc subdir in the jar, or does some special provision need to be made to get that to happen?

[stevedlawrence]

Yep, anything in src/main/resources ends up in the root of the jar, including any subdirectories. Nothing special needs to be done.

[mbeckerle]

So perhaps all we need is guidelines that the README.md is for us, and user doc, rel-notes, instructions, whatever we want to include is just referenced from the README but lives under src/main/resources/doc ?