AI for README Files: Make Your Project Look Pro

End-of-lesson check

15 questions · take it digitally for instant feedback at tendril.neural-forge.io/learn/quiz/end-builders-ai-coding-AI-and-readme-files-teen

1. What is the main purpose of a README file in a GitHub repository?

   1. To hide code that isn't finished yet
   2. To replace all the comments in your source code
   3. To automatically run tests on your project
   4. To make the repository look professional and help others understand the project

2. Why should you edit an AI-generated README instead of using it exactly as written?

   1. Because GitHub rejects READMEs that sound like they were written by AI
   2. Because AI-generated READMEs always contain incorrect information
   3. Because generic-sounding READMEs make your project appear low-effort to visitors
   4. Because AI cannot generate text longer than one paragraph

3. Which section would most help a visitor understand how to install your project?

   1. A paragraph explaining your favorite programming language
   2. A long list of all your GitHub followers
   3. An installation section with command-line steps
   4. A collection of random memes

4. If you paste your package.json file into an AI tool, what can you reasonably ask it to generate?

   1. A video game that you can play in the terminal
   2. A README outline tailored to your project's dependencies and scripts
   3. A new programming language that compiles to JavaScript
   4. A fully functioning website hosted on the internet

5. What is the 'Why I built this' section supposed to contain?

   1. Technical details about how the compiler works
   2. A list of all the bugs you encountered while coding
   3. A personal explanation of your motivation and the problem you wanted to solve
   4. A collection of every error message you ever received

6. What are screenshot placeholders in a README used for?

   1. To automatically take screenshots of visitors' computers
   2. To hide inappropriate content from appearing in the README
   3. To replace broken code with working code
   4. To show where images of your project interface should eventually go

7. What does the term 'open source' mean in the context of GitHub projects?

   1. Code that has no bugs or errors
   2. Code that automatically opens when you start your computer
   3. Code that is publicly available for others to view, use, and sometimes modify
   4. Code that only runs on open operating systems

8. What should a 'contributing' section in a README explain?

   1. How others can suggest changes or add features to your project
   2. How to delete your repository from GitHub
   3. How to format your social media posts about the project
   4. How to contact your school principal

9. Why might AI be able to write a solid README in about 30 seconds?

   1. Because it can quickly combine standard documentation patterns based on your project details
   2. Because it compiles your code and runs it automatically
   3. Because it reads your mind and knows exactly what you want
   4. Because it has access to your private files on other computers

10. What does it mean for a README to sound 'like you'?

    1. Written in your personal voice and style, not generic AI language
    2. Written only using words from the dictionary
    3. Written in a foreign language you don't speak
    4. Written entirely in code comments

11. What is 'documentation' in the context of software projects?

    1. The license file that comes with most programming languages
    2. Written material that explains how a project works and how to use it
    3. The process of printing your code on paper
    4. A collection of random comments scattered through your code

12. Which of these would NOT typically be found in a well-structured README?

    1. A description of what the project does
    2. Usage examples
    3. A recipe for chocolate chip cookies
    4. An installation guide

13. What do usage examples in a README demonstrate?

    1. How to actually use your project with real commands or code snippets
    2. A list of every variable name used in your code
    3. Your entire source code pasted multiple times
    4. The history of how programming languages were invented

14. What makes a GitHub repository look 'serious' or professional?

    1. Deleting all your commit history
    2. A complete, well-written README that clearly explains the project
    3. Having exactly 1,000 lines of code
    4. Using only obscure programming languages

15. What happens if you leave an AI-generated README completely unedited?

    1. Your code will automatically be deleted by GitHub
    2. Visitors may perceive your project as low-effort because it sounds generic
    3. Your project will be flagged as spam
    4. The AI will continue editing the file forever