Skip to content

Feature request: link to the README in the documentation #650

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
Closed
evertrol opened this issue Aug 24, 2023 · 0 comments · Fixed by #692
Closed

Feature request: link to the README in the documentation #650

evertrol opened this issue Aug 24, 2023 · 0 comments · Fixed by #692

Comments

@evertrol
Copy link

The user's guide has an installation section, but that doesn't say anything. It mentions that the README file has the relevant information, but there is no link to that README. I would have to know to go to GitHub, and scroll down (or click the file) to view the readme.

A direct link to the README from the documentation , or otherwise a full inclusion of the relevant installation text in the documentation would be nice.
@methane methane mentioned this issue Feb 4, 2024
Merged
methane added a commit that referenced this issue Feb 4, 2024
@methane
doc: add link to README (#692)
8b032d1 
Fix #650
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: add link to README methane/mysqlclient
1 participant
@evertrol