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.

Sign up for GitHub

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

Jump to bottom

Documentation improvements #114

Open
taiki-e opened this issue Feb 6, 2021 · 1 comment
Open

Documentation improvements #114

taiki-e opened this issue Feb 6, 2021 · 1 comment
Labels
C-documentation Category: related to documentation.

Comments

@taiki-e
Copy link
Owner

taiki-e commented Feb 6, 2021

The current readme just lists the options and it is not very easy to read.

It may be good to add a section like "Examples" to introduce some commonly used flags.

related: hyperium/hyper#2422
@taiki-e taiki-e added the C-documentation Category: related to documentation. label Feb 6, 2021
@taiki-e
Copy link
Owner Author

taiki-e commented Feb 6, 2021

It would also be nice to have an explanation about #81. It explains why the number of feature combinations actually performed is less than the user expects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-documentation Category: related to documentation.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@taiki-e