chore: create readme with community examples #1940
Conversation
WalkthroughA new README.md file was introduced in the Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/mips/psyqo/examples/README.md (2)
3-3: Hyphenate 'community-made' for clarityThe term “community made” should be hyphenated to “community-made” to improve readability and adhere to compound modifier rules.
7-7: Remove trailing table pipe and simplify wordingThe trailing
|on the table row violates markdownlint’s table-pipe-style (MD055), and “off of” is wordy. Consider the following diff:-| [psyqo-cdrom-cube](https://github.com/Forceh91/psyqo-cdrom-cube) | [Forceh91](https://github.com/forceh91) | This example attempts to give a real-world example of loading a model off of the CD-ROM for rendering | +| [psyqo-cdrom-cube](https://github.com/Forceh91/psyqo-cdrom-cube) | [Forceh91](https://github.com/forceh91) | Demonstrates loading a model from the CD-ROM for rendering |🧰 Tools
🪛 LanguageTool
[style] ~7-~7: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...a real-world example of loading a model off of the CD-ROM for rendering |(EN_WORDINESS_PREMIUM_OFF_OF)
🪛 markdownlint-cli2 (0.17.2)
7-7: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe(MD055, table-pipe-style)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/mips/psyqo/examples/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/mips/psyqo/examples/README.md
[style] ~7-~7: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...a real-world example of loading a model off of the CD-ROM for rendering |
(EN_WORDINESS_PREMIUM_OFF_OF)
🪛 markdownlint-cli2 (0.17.2)
src/mips/psyqo/examples/README.md
7-7: Table pipe style
Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
(MD055, table-pipe-style)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/mips/psyqo/examples/README.md (2)
3-3: Refine wording for clarity and conciseness.Consider simplifying the sentence to be more direct and remove unnecessary words.
-The following list contains community-made examples which have made use of various aspects of psyqo. +The following community examples illustrate various features of psyqo.
7-7: Simplify phrasing and fix table formatting.Replace the wordy “off of” with “from the” and add a trailing pipe for proper Markdown table alignment.
-| [psyqo-cdrom-cube](https://github.com/Forceh91/psyqo-cdrom-cube) | [Forceh91](https://github.com/forceh91) | This example attempts to give a real-world example of loading a model off of the CD-ROM for rendering +| [psyqo-cdrom-cube](https://github.com/Forceh91/psyqo-cdrom-cube) | [Forceh91](https://github.com/forceh91) | This example demonstrates loading a model from the CD-ROM for rendering |🧰 Tools
🪛 LanguageTool
[style] ~7-~7: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...a real-world example of loading a model off of the CD-ROM for rendering(EN_WORDINESS_PREMIUM_OFF_OF)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/mips/psyqo/examples/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/mips/psyqo/examples/README.md
[style] ~7-~7: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...a real-world example of loading a model off of the CD-ROM for rendering
(EN_WORDINESS_PREMIUM_OFF_OF)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Codacy Static Code Analysis
No description provided.