Skip to content

Generating a README.md

This prompt works best for argentic tools that build embeddings for all the files in your project. I use claude code, but I know that Cursor, Windsurf and other tools that work directly on your checked out desktop files. Make sure you set your context to the location of your checked out code.

Prompt

Please update the README.md file to be consistent with GitHub repository best practices. Put the badges in first and at the end, make sure to put in acknowledgements for all the open source projects used in this course.

Sample Results

  1. README.md for our course on how to build Intelligent Books

  2. README.md for the Systems Thinking Course

  3. README.md for the Data Science with Python and AI Course

  4. README.md for the Signal Processing Course

  5. README.md for the Learning MicroPython Course

  6. README.md for the STEM Robots Course

  7. README.md for the Clocks and Watches Course

  8. README.md for the Tracking AI Course