PY-1.4-BP6-MQ40

Our Goal: Make a README for Your Game

In this lesson, you will make a special file called README.md for your game. This file is like a guide for your game. You will write about what your game is, how to play it, and who helped make it. A good README.md helps everyone understand your game better!

Check Your Project

Before you make your README.md file, let's check your project. We will run some tests to see if the README.md file is there and if it has a basic structure.

Run this command in your terminal:

pytest module-1.4/blueprint-BP6/quest-40

What you should see:

āŒ Some tests will fail. This is okay for now! It means the README.md file is not yet made, and the tests are waiting for you to make it.

Make Your README File

Now, you will create your README.md file and add the important 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 Game
    
  3. Write a short story (description) about your game. This tells people what your game is about.

  4. Add a new title for 'How to Play'. Under this, explain how to play your game.

  5. Add another new title for 'Credits' or 'Who Helped'. Under this, you can list who helped you or what tools you used.

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's good.

Run this command in your terminal:

pytest module-1.4/blueprint-BP6/quest-40

What you should see:

āœ… All tests should pass! This means your README.md file is set up correctly.

Remember to also read your README.md file yourself. Does it clearly tell people about your game, how to play it, and who helped make it?

Documentation

Documentation not available for PY-1.4-BP6.