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

Add README #5

Closed
adamgundry opened this issue Mar 10, 2017 · 4 comments
Closed

Add README #5

adamgundry opened this issue Mar 10, 2017 · 4 comments
Assignees

Comments

@adamgundry
Copy link
Member

This should explain the motivation behind optics, basic usage and the differences from lens.

@adamgundry adamgundry mentioned this issue Dec 13, 2018
5 tasks
@arybczak
Copy link
Collaborator

arybczak commented Feb 4, 2019

Perhaps we should move stuff that currently sits in optics/src/Optics.hs into README?

Then it's displayed on both github and hackage.

@adamgundry
Copy link
Member Author

Good plan. I'm still planning to do a pass over the documentation at some point, but time is ever a problem...

@phadej
Copy link
Contributor

phadej commented Feb 6, 2019

Note: optics/src/Optics.hs has haddock tests; and identifiers are links into documentation of that version.

@adamgundry
Copy link
Member Author

I'm now inclined to make the README relatively minimal, with some brief motivation and a link to the Haddocks on Hackage, rather than duplicating content. But it still needs to be written.

@adamgundry adamgundry self-assigned this Mar 13, 2019
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

3 participants