docs: README.md update - Consistency updates

[VaclavElias]

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

#2265

Types of changes

• 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

• 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]

I still need to do a few tests but we can start the conversation. The main highlight is to bring clarity and direct game devs vs contributors where they should go.

It might look reperative but it depends, where you land. So any of the pages mentioned below will direct/redirect you further.

Get started with Stride

The Get started pages also adds some intro https://stride-doc-staging.azurewebsites.net/latest/en/manual/get-started/index.html

Install Stride

And so do Install page https://stride-doc-staging.azurewebsites.net/latest/en/manual/get-started/install-stride.html

[VaclavElias]

Additionally, this PR brings README.md consistency across:

• https://github.com/stride3d/stride-docs
• https://github.com/stride3d/stride-website
• https://github.com/stride3d/stride-community-toolkit

[Eideren]

I think we can do without the table of contents, our readme isn't that long
earn-money-by-contributing goes nowhere, Code of conduct has been removed, make sure that we aren't missing any important stuff.

[VaclavElias]

Re: Code of conduct, it has now a dedicated place. I learned about this one from other repos 😯

[VaclavElias]

The purpose of Table of Contents is really just a shortcut link to take you down, so you don't have to scroll. The title itself could be removed.

You can check how it works here: https://github.com/VaclavElias/stride/tree/readme-update

Earn Money, is a shortuct, which takes you down in the page, where is the old content.

[Jklawreszuk]

Win 11 SDK ? Are you sure about this?

[VaclavElias]

100%, tested on clean Win 11. It is selected by default actually by the installer.

[VaclavElias]

We had there before Windows 10 SDK

[Jklawreszuk]

I think this requirement applies to UWP, so it's not a big deal. I wonder if version is also correct🤔

[VaclavElias]

It is, see below:

[Jklawreszuk]

Overall I would keep README.md file as short as possible, so I would also concider removing TOC and shortify " Stride Documentation Landscape" paragraf maybe(?)

[Jklawreszuk]

Otherwise nice work

[Jklawreszuk]

I guess both commands can be combined as well

Suggested change

	msbuild /t:Restore Stride.sln
	msbuild /t:Restore Stride.sln; compile.bat

[VaclavElias]

I have to test this part also on clean Win 11. Once tested and working, I will take it 🙂

[VaclavElias]

Overall I would keep README.md file as short as possible, so I would also concider removing TOC and shortify " Stride Documentation Landscape" paragraf maybe(?)

Have you tried this link? https://github.com/VaclavElias/stride/tree/readme-update

The purpose of a Table of Contents is to help you quickly navigate to a section without scrolling. This becomes a time saver when you repeatedly access the same part of the page. If you only visit the README once a year, it might be unnecessary. But if you're there frequently, it definitely helps. If you and the team have considered this perspective and still see no benefit, then sure, it can be removed. 🙂

Regarding the Stride Documentation Landscape, there's also a strategic reason for its inclusion across all repositories: Docs, Website, and Toolkit. We face a challenge with users finding the material we already have. So, no matter which repository you land on, if you bother to scroll to the bottom, all the important links are available at a glance. This allows users to navigate anywhere without needing to go to Discord to ask where things are. This feature is a time saver for us, as we don't have to repeatedly direct people to certain parts of our documentation landscape. Ideally, users will find what they need themselves, allowing us to save our time for PRs and other tasks. 🤣

Also, it's intentionally placed at the bottom so it doesn’t clutter the top of the README.

By the way, once the Docs Contributors https://doc.stride3d.net/latest/en/contributors/engine/index.html section is sorted and reviewed, we can move the entire Building from Source section to our docs. This way, we won’t have to maintain and update it in two places.