Improving readme, wiki, and ux.

[fklemme]

This is a great project but I feel the README, the wiki, and error messages need some improvements to explain basic things.

1. How do I build the thing (if I don't know how to gradle)?
2. Point to the wiki in the README. Most people will otherwise miss it.
3. Improve error messages of the application. Missing files or folders just throws an exception with questionable guidance of what's missing. Also the errors for the deck list are sometimes confusing: Island -> error, 1x Island -> okay, 1x Storm Crow-> error, empty line in a long list -> error.
4. Why are all examples given with --template=[...].zip but there is neither a zip nor the explanation what needs to be in it / how to create it. Also, the option to use folders is missing in the wiki.

[fklemme]

Storm Crow is now flying as expected. That one was on me. 😅

[justingolden21]

As for documentation, I would:

• point people to the wiki from the README
• make sure you mention that they need java, provide links (https://www.oracle.com/java/technologies/downloads/#java16-windows for windows)
• link to the jar file, mention to clone the repo and paste templates in there
• mention file location of templates, https://github.com/Haven-King/Proximity/wiki/Templates etc
• provide zip templates so one doesn't have to clone a 700mb repo in order to start

Also, there seems to be a bug with generating cards using the normal template:

Love this project, keep working on it : ) Thank you!

[Haven-King]

@justingolden21 The README does point to the wiki, which states that Java 16 is required. I don't provide a download linked intentionally. Users do not need to clone the repo at all, the template is published on the release page as well (chillis-0.4.0.zip). You are encountering issues generating cards because you are using the published jar version (0.4.0) with the in-development version of the template. Please download the template from the releases page :)

[justingolden21]

Got it, thanks for the help.

I just ran into a lot of issues and was kind of lost at the repo, but I think that's just me. I would look into organizing it a bit more if possible, but it's fine for now. Thanks for the quick and helpful reply.

[lpnam0201]

Hello,
From version 0.5.1 onwards, why wasn't the chillis-0.4.0.zip included in the release ?
Should we also update the wiki with some line pointing to the templates ? It took a while until I finally found it
(something like "refer to the template section / see releases for templates)

Any templates you want to use should go in this folder. (a question newer users like me may have is "Where do we obtain these templates ?")

Thanks.