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

Reorganize README with a quickstart of common usage #32

Open
Keno opened this issue Jun 3, 2014 · 5 comments
Open

Reorganize README with a quickstart of common usage #32

Keno opened this issue Jun 3, 2014 · 5 comments
Labels

Comments

@Keno
Copy link

Keno commented Jun 3, 2014

This package has gotten quite complex (which is awesome!), but I'm afraid that users who just want to change the color of a plot or something might be scared off by the README. Having a simple quickstart section with common usage ala color("red"), colormap("whatever") would be a good idea.

@StefanKarpinski
Copy link
Contributor

This has turned into one of my favorite packages because of the intense use of immutables and multiple dispatch. I know very little about color spaces and such, but it seems to me that this may be one of the more extensive and complete color manipulation libraries around at this point.

@glennsweeney
Copy link
Contributor

I don't know of any better libraries in existence, and yet it is still growing rapidly.

I'm not sure I'm the right man to work with the documentation, as I'm pretty new here. However, I'm happy to offer input where needed.

@rennis250
Copy link

My line of research is colour perception and I agree with @StefanKarpinski and @glenn-sweeney that this is one of the most comprehensive and impressive colour packages I have seen for a programming language. Being that colour is what I think about every day, I feel rather guilty that I have not had a chance to assist with this package and would be overjoyed the lend a hand with the documentation. I will start to draft something this weekend.

Best,
Rob

@rennis250
Copy link

And, @glenn-sweeney, looking at your resume, I would certainly say that you should get your hands dirty in this package, too. ;)

Best,
Rob

@glennsweeney
Copy link
Contributor

Rob,

Thanks for the input. ;) I'm still a "lowly" student, but I've done what I can to add a little bit of functionality here and there. I'm going to be away from my computer for much of the summer, but next fall I'm going to be continuing studies, and with that comes more work in Color.

If you get a draft of documentation going by all means share it, and I can provide input where it is appropriate for me to do so.

-Glenn

@jiahao jiahao added the doc label Aug 27, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants