stride icon indicating copy to clipboard operation
stride copied to clipboard

docs: README.md update - Consistency updates

Open VaclavElias opened this issue 4 months ago • 8 comments

This pull request updates the README.md file to improve its structure, readability, and navigation. The changes include adding hyperlinks, reorganizing sections, and enhancing the overall content to provide a better user experience.

Enhancements to README.md:

  • Navigation and Structure:

    • Added a Table of Contents to improve navigation.
    • Reorganized sections for better readability and flow, including "Getting Started," "Contributing," "Roadmap," "Building from Source," and "Documentation Landscape." [1] [2]
  • Content Updates:

    • Enhanced the introductory section to provide a clearer overview of the Stride Game Engine and its features.
    • Added detailed instructions for building the Stride engine from source, including prerequisites and troubleshooting tips.
    • Updated the contributing section to include information on how to report bugs, propose features, and get involved with the community.
  • Hyperlinks and References:

    • Added hyperlinks to key resources, such as the Game Studio, documentation, and community channels.
    • Linked to the official Stride website and relevant documentation sections to provide easy access to additional information. [1] [2]
  • Visual Enhancements:

    • Wrapped the Stride logo in a hyperlink to the official website for better branding and user engagement.
    • Included visual indicators (e.g., emojis) to highlight important sections and improve the document's visual appeal.

These changes aim to make the README.md more user-friendly and informative, helping new users get started quickly and existing users find the information they need more efficiently.# PR Details

This PR brings consistency across Stride repos.

You can see the updated version here: https://github.com/VaclavElias/stride/tree/readme-update

Related Issue

https://github.com/stride3d/stride/issues/2265

Types of changes

  • [x] Docs change / refactoring / dependency upgrade
  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • [x] My change requires a change to the documentation.
  • [ ] I have added tests to cover my changes.
  • [ ] All new and existing tests passed.
  • [ ] I have built and run the editor to try this change out.

VaclavElias avatar Sep 29 '24 20:09 VaclavElias