PY-1.4-BP4-MQ30

Our Goal: Make a README File

In this lesson, you will make a special file called README.md. This file is like the front door of your project. It tells people what your game is about. You will add a main title for your game and a short story about it in this file.

Get Ready to Write

Before you make your README.md file, make sure you are in the main folder of your game project. This is where the README.md file should be.

Right now, you should not have a README.md file in your project. This means you are ready to create it!

Make Your README File

Now, you will create your README.md file and add the first parts to it.

  1. Create a new file in your project's main folder and name it README.md.

  2. Inside this file, add a main title for your game. You can use a single '#' symbol for a main heading in Markdown, like this:

    # My Awesome Pong Game
    
  3. Below the title, write a short paragraph that tells people what your game is about. For example:

    This is a fun Pong game where two players hit a ball back and forth. The first player to reach 5 points wins!
    

Remember to save your README.md file after you add the content.

Check Your Work Again

You've made your README.md file! Now, let's check to make sure it looks good.

Open the README.md file you just made. You can open it with a text editor or a Markdown viewer.

What you should see:

āœ… The file should be named README.md and be in your main project folder. āœ… It should have a big title for your game. āœ… Right below the title, there should be a short story (one paragraph) about your game.

If you see these things, you did a great job!

Documentation

Documentation not available for PY-1.4-BP4.