Skip to content
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.

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

Lack of Documentantion #2

Open
diogoviannaaraujo opened this issue Oct 31, 2014 · 1 comment
Open

Lack of Documentantion #2

diogoviannaaraujo opened this issue Oct 31, 2014 · 1 comment

Comments

@diogoviannaaraujo
Copy link

Hey, since I've been the last days learning about your library I was think i could try to improve the library documentation. Do you have something besides the readme?
And if not, where do you think I should start documenting it, and how?
I have almost no experience in documentation, but it think i could start something

@joshmarinacci
Copy link
Owner

I agree. Documentation is sorely lacking. I don't have anything currently besides the Readme.MD file. I'd start in the wiki. A few things you could create:

  • simple examples like: here's how to make a button and an image. here's an RSS feed.
  • copy some examples from my blog: http://joshondesign.com/tags/amino
  • document some of the core objects. What properties does Rect have vs Text.

Thanks so much. I really appreciate having users who provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants