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.

Sign up for GitHub

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

Jump to bottom

Update README & Other Considerations #1

Open

5 tasks

bytecauldron opened this issue Jan 21, 2023 · 0 comments

bytecauldron commented Jan 21, 2023

Before we get into the meat and potatoes of documentation, it might be a good idea to beef up the README file.

Dedicated section highlighting major features.
"Getting Started" section with instructions on how to install. (I.E. provide a Unity Package. Install instructions through a git url and/or local install?) This would also link to an inevitable quickstart doc.
Contributing File.
License (Let people know what they are getting into if they decide to use this for commercial/non-commercial use.)
Sick logo (of course).

More than happy to help with any of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment