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

High-level tutorial guide with examples #10

Open
nicholas-miklaucic opened this issue Feb 12, 2018 · 0 comments
Open

High-level tutorial guide with examples #10

nicholas-miklaucic opened this issue Feb 12, 2018 · 0 comments
Assignees

Comments

@nicholas-miklaucic
Copy link
Owner

I'll probably take care of this one myself, just so you know.

Rustdoc is nice and all, but a lot of crates lack the really crucial last step: a high-level guide that goes through common use cases. Giving people documentation on everything in the library isn't useful if people need to search all of that just to figure out how to do the thing they want to do.

I'm thinking worked code examples, that compile and do useful things, for things that people might want to do:

  • Generate a triadic color scheme
  • Equalize colors by luminance
  • Compare the difference in various methods of getting grayscale versions of a color
  • Replicate the famous Wright-Guild experiment (ok, probably better as a demo)

With something like this, where it's hard to explain what it does clearly to anyone who isn't a color scientist, it's especially important to have some cool demo or something that people can look at and then see parts of that functionality that they wanna use.

@nicholas-miklaucic nicholas-miklaucic self-assigned this Feb 21, 2018
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

1 participant