Document Your Game

Objective: Document Your Game

Welcome to the final quest in this blueprint! Your objective is to create a README.md file in your project's root directory. This file will serve as essential documentation for your game.

Using Markdown, you will write a description of your game, explain how to play it, and list any credits or technologies used. A good README is crucial for anyone looking at your project, whether it's a potential player, collaborator, or future you!

Check Specification

Before we start, let's check the current state of the project against the requirements.

Run the verification tests provided. These tests will check if the README.md file exists and has a basic structure.

Expect the tests to fail initially, as you haven't created the file yet. This step confirms the starting point and the specification we need to meet.

Verification Results:

  • Test that the README.md file exists in the project root.
  • Test that the README.md file is not empty.
  • Test that the README.md file contains at least one Markdown header, suggesting some basic structure like a title.

Implement: Create README.md

Now, let's create the README.md file and add the required content using Markdown.

Create a new file named README.md in the root directory of your project (at the same level as main.py). Then, add the content as described in the tasks below.

Remember to use Markdown syntax to format your text, including headings, lists, and paragraphs.

Step by step checklist:

  1. Create a new file named README.md in the project's root directory.
  2. Add a main heading for your game's title using Markdown.
  3. Write a brief description of your game using Markdown paragraphs.
  4. Add a heading for 'How to Play' and provide instructions using Markdown lists or paragraphs.
  5. Add a heading for 'Credits' or 'Technologies Used' and list any relevant information using Markdown lists or paragraphs.

The following documentation sections are going to be helpful:

  • README Creation with Markdown
  • Markdown

Validate Your Work

You've created the README.md file and added content. Now, let's validate your work to ensure it meets the basic requirements.

Run the verification tests again. This time, they should pass if the README.md file exists, is not empty, and contains at least one Markdown header.

Remember that automated tests can only check for structural requirements. The quality and clarity of the content (description, instructions, credits) are something you should review yourself or have a mentor review.

Verification Results:

  • Test that the README.md file exists in the project root.
  • Test that the README.md file is not empty.
  • Test that the README.md file contains at least one Markdown header, suggesting some basic structure like a title. All verification steps passed!

Documentation

Documentation not available for PY-1.4-BP6.