docs: add registry way to create a new project

[Miou-zora]

Pull Request

Description

I added a better way to create a project out of Engine Squared

Related Issues (Optional, put "None" if there are no related issues)

Fixes#530

Type of Change

• Documentation update
• Project related stuff

Changes Made

List of the main changes in this PR:

• Added documentation to create a new project out of nothing

Testing (Optional, put "None" if you didn't have to test anything)

• Manual testing performed (describe what you tested): running commands

Test Environment

• OS: macOS
• Compiler: Clang

Documentation

• I have updated the relevant documentati

Checklist (Don't delete any options)

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published

Time Spent (Optional, put "None" if you don't know)

less than 1h

Screenshots/Videos (Optional, put "None" if it's not relevant)

None

Breaking Changes (Optional, Put "None" if there are no breaking changes)

None

Additional Notes (Optional, Put "None" if there are no additional notes)

None

Summary by CodeRabbit

• Documentation
  • Restructured getting-started guide with improved organization and clearer setup instructions.
  • Added project creation guidance, example setup procedures, and minimal example walkthrough.
  • Enhanced documentation flow for faster user onboarding and setup experience.

[coderabbitai]

📝 Walkthrough

Walkthrough

README.md documentation is restructured to improve the getting-started experience. A new "Hello World" section introduces the examples directory and BasicCoreUsage sample. Project creation instructions are added with xrepo add-repo and xmake create commands. The examples section is expanded with clone/configure steps, a Windows toolchain note, and explicit instructions to build and run the minimal example.

Changes

README Getting-Started Documentation Update

Layer / File(s)	Summary
Getting-started documentation flow README.md	Hello World subsection introduced; Create your project section added with xmake template commands; Check examples section expanded with repository cloning, build configuration guidance, Windows MSVC toolchain note, and Run a minimal example instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• EngineSquared/EngineSquared#482: Prior README.md modification to the examples and getting-started sections with similar structural goals.
• EngineSquared/EngineSquared#556: Earlier README.md rework of getting-started documentation and minimal example execution flow using the same BasicCoreUsage pattern.

Suggested labels

documentation

Poem

📖 A rabbit hops through docs with care,
Restructuring the getting-started fare,
"Hello World" now shines so bright,
xmake templates set things right,
New users smile—the path is clear! 🐰

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	Title clearly summarizes the main change: adding documentation for the registry-based project creation method using xmake templates.
Linked Issues check	✅ Passed	PR addresses the documentation requirement from #530 by documenting the registry way to create projects, meeting the 'Document templates in the main repository' objective.
Out of Scope Changes check	✅ Passed	All changes are focused on README documentation updates related to project creation instructions, directly aligned with the linked issue's requirement to document templates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 530-chore-add-xmake-templates-to-simplify-project-creation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Miou-zora]

@coderabbitai review

[coderabbitai]

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud