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

Update README.md #3220

Closed
wants to merge 1 commit into from
Closed

Conversation

mrbeandev
Copy link

I ran into this error, a widespread error we get when we install a project. So it is good to mention this in the readme so users don't have to search the web for hours like I did

I ran into this error, a widespread error we get when we install a project. So it is good to mention this in the readme so users don't have to search the web for hours like I did
@mcmonkey4eva
Copy link
Collaborator

We don't generally list every possible mistake & solution in README's, this one here is a basic YAML formatting mistake, it's better to make simple issue/discussion posts with clear titles & examples so if someone else has the same issue they will find it quickly with a google search.
Or alternately build a FAQ/Troubleshooting guide, but that should be done by someone with more experience so they can make sure the solutions are all correct and relevant

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

Successfully merging this pull request may close these issues.

None yet

2 participants