Docs/fix readme

[kimkulling]

Summary by CodeRabbit

• Documentation
  • Introduced comprehensive developer guidelines covering project setup, build configurations, testing procedures, and code conventions.
  • Updated README with corrected instructions, improved clarity, and added platform-specific build and run guidance for Windows and Linux.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 65c7f664-d26e-497d-9364-6e8eb5bfeecf

📥 Commits

Reviewing files that changed from the base of the PR and between fbed507 and e79fb8d.

📒 Files selected for processing (2)

• AGENTS.md
• README.md

---

Walkthrough

This pull request adds a new AGENTS.md documentation file consolidating developer guidelines for the Segfault project, covering setup, build, testing, code style, and project structure. Additionally, README.md receives minor corrections and improvements, including prerequisite clarifications, build instruction updates, and platform-specific run instructions.

Changes

Cohort / File(s)	Summary
Documentation AGENTS.md	New developer guidelines document covering project overview, build/setup commands, testing instructions, shader tooling, code style conventions, namespace practices, class design, error handling, documentation standards, platform macros, export semantics, and project structure.
Readme Updates README.md	Typographical corrections (e.g., "Prerequisities" → "Prerequisites"), build instruction clarifications, git workflow updates (checkout to clone with submodules), and new platform-specific run instructions for Windows and Linux.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• Add agends #5: Directly related—adds the same AGENTS.md documentation file with overlapping content regarding developer guidelines.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/fix_readme

---

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.}

[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