Skip to content

Instantly share code, notes, and snippets.

View hafidaso's full-sized avatar
🎯
Focusing

Hafida Belayd hafidaso

🎯
Focusing
View GitHub Profile
@planetoftheweb
planetoftheweb / README prompt generator
Created July 6, 2024 15:52
Prompt for Generating README files using Chat GPT
You're a professional and experienced web developer and open source contributor. Create a first release README document for these files. The target audience is professional developers with five years of experience building online projects.
- Include a description
- A list of interesting techniques the code uses in the files provided. When possible link to MDN documentation as part of the text of the technique.
- A list of non-obvious technologies or libraries used in the code that would be of interest to professional developers with medium level experience.
- Make sure you add links to external libraries, including links to any specific fonts used.
- A breakdown of the project structure as a directory list code block: Include directories like any images directories or subfolders implied by the code, but not individual files unless they're in the root directory. Add a short description of any interesting directories underneath the code block
- If you mention a file or directory in the description, link to the