Add demo tutorial

[Gargaj]

This may be niche and may only pertain to demoscene enthusiasts, but still.

Summary by CodeRabbit

• Documentation
  • Added a new "Build your Own Demo" section.
  • Introduced a curated tutorial link for creating a concise C++ demo.

[coderabbitai]

Walkthrough

The changes update the documentation by adding a new section in the README titled "Build your own Demo." This section expands the table of contents with an entry for a C++ demo tutorial, providing users with a concise guide on writing a demo in under 400 lines.

Changes

File	Change Summary
README.md	Added a "Build your own Demo" section with a table of contents entry and a link to a C++ demo tutorial resource.

Poem

I'm a bunny with a code so bright,
Hopping through docs in morning light.
A new section sprouted in our tree,
Demo dreams in C++ set free.
With hops and clicks, our work takes flight!
🐇✨

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

153-156: New “Build your own Demo” Section Introduced
The new section with header #### Build your own Demo and the associated C++ tutorial link integrate well into the document. However, markdownlint has flagged an emphasis style warning on line 155: the tutorial description uses underscores for italics, while the expected style is asterisks. Consider replacing the underscores with asterisks for consistency with your project's Markdown conventions.

Apply the following diff to fix the emphasis style:

-* [**C++**: _How to start writing an actual demo in <400 lines_](https://gargaj.github.io/demos-for-dummies/)
+* [**C++**: *How to start writing an actual demo in <400 lines*](https://gargaj.github.io/demos-for-dummies/)

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

155-155: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

---

155-155: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b7d32b and 650ab5a.

📒 Files selected for processing (1)

• README.md (2 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

README.md

155-155: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

---

155-155: Emphasis style
Expected: asterisk; Actual: underscore

(MD049, emphasis-style)

🔇 Additional comments (1)

README.md (1)

18-18: New Table of Contents Entry for “Demo” Added
The new "Demo" entry in the Table of Contents is a clear and useful addition. Just verify that the link (#build-your-own-demo) correctly points to the new section that is added later in the document.