improve documentation

Open
#21 0 comments 0 reactions 1 assignee View on GitHub

@bengreenier is already working on this.

Since Feb 16, 2018.

Assessment

This issue has not been assessed yet.

Description

enhancement

The documentation around how you might use and configure the various aspects of the menustack should be improved - recently some folks asked how this project was useful, and pointed out that the readme wasn't clear enough.

I'd like to add:

  • some quick usage walkthroughs
  • additional "about" documentation
  • a gif of a quick setup/usage
  • a github pages site with more of this content surfaced
Dominant language
C#
Stars
12
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bengreenier/Unity-MenuStack

All issues in bengreenier/Unity-MenuStack

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.