search

Hexworks / mixite

A GUI agnostic hexagonal grid library. Supports a multitude of grid layouts including hexagonal, triangular, rectangular and more.
Apache License 2.0
191 stars 31 forks source link

Shorten readme slightly #48

Closed drekbour closed 4 years ago

drekbour commented 4 years ago

IMO the readme serves as your shop window not a manual. Example code doesn't need imports to demonstrate what Mixite usage looks like.

WIP: Before accepting the PR, can you clarify the intention of imports mixite.core, mixite.core-jvm, mixite.core-web and mixite.core-js (which does not seem to exist) here so I can include that.

adam-arold commented 4 years ago

Thanks @drekbour for your PR! I agree with the overall sentiment but for this to work we would need a Wiki where there are copy-paste-able code samples. This is something which I'd really like to keep because 9 out of 10 complaints about OSS projects involve broken sample code or missing imports. Would you mind coming up to our Discord Server to discuss this?

drekbour commented 4 years ago

Updated per Discord.