Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/rb 156 better readme #133

Merged
merged 3 commits into from
Oct 30, 2023
Merged

Fix/rb 156 better readme #133

merged 3 commits into from
Oct 30, 2023

Conversation

Saverio976
Copy link
Collaborator

@Saverio976 Saverio976 commented Oct 30, 2023

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Norm of the code has been respected
  • In what state is your pull request?
  • Ready to merge / Waiting a reviwer to see my work.
  • Work In Progress (WIP) / My work is not finish but i want daily reviews. (Draft)
  • CI Review / I want to see what the CI thinks of my work.
  • Need feedback / Just to have feedback on what i produced. (May not be merged)
  • What kind of change does this PR introduce? (You can choose multiple)
  • Bug fix
  • Feature request
  • New / Updated documentation
  • Testing CI ( Make the pull request in draft mode)
  • What is the current behavior? (link an issue based on the kind of change this pr introduce)

  • What is the new behavior (if this is a feature change)?

  • Other information:

Summary by CodeRabbit

New Features:

  • Introduced MacOS version of R-Bus game, now available for download.

Documentation:

  • Updated README.md with a detailed description of R-Bus and installation instructions for GNU/Linux, Windows, and MacOS.
  • Enhanced GNU/Linux installation script for improved readability and clarity.
  • Provided new download links for Windows and MacOS versions in their respective installation guides.

Style:

  • Improved formatting of the GNU/Linux installation script for better readability.

@Saverio976 Saverio976 added the documentation Improvements or additions to documentation label Oct 30, 2023
@Saverio976 Saverio976 requested a review from TTENSHII October 30, 2023 14:03
@Saverio976 Saverio976 self-assigned this Oct 30, 2023
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2023

Walkthrough

The changes introduced in the R-Bus project primarily focus on enhancing the user experience by providing detailed installation instructions for different platforms, including GNU/Linux, Windows, and MacOS. The README.md file has been updated with a project description, installation links, and an updated list of contributors.

Changes

File Path Summary
docs/README.md Added a project description, installation instructions for different platforms, and an updated list of contributors.
docs/user-guide/installation/packaged-binary/.../gnu-linux.md Improved the script for downloading and installing the R-Type game on GNU/Linux.
docs/user-guide/installation/packaged-binary/.../macos.md Updated the availability of the MacOS version and provided a download link.
docs/user-guide/installation/packaged-binary/.../windows.md Updated the instructions for running a Windows application and provided a new download link.

🐇🍂

In the season of fall, when leaves gently descend,

CodeRabbit hopped in, changes to commend.

With a hop and a skip, and a keystroke delight,

Installation's a breeze, in the soft autumn light.

From Linux to Windows, and MacOS in sight,

R-Bus is ready, for a gaming night.

So here's to the coders, their efforts we cheer,

Happy gaming to all, and a bountiful year! 🎮🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.
  • @coderabbitai resolve to resolve all the CodeRabbit review comments.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 6640802 and f13a91b.
Files ignored due to filter (1)
  • assets/icons/xlrgb-logo.png
Files selected for processing (4)
  • docs/README.md (1 hunks)
  • docs/user-guide/installation/packaged-binary/gnu-linux.md (1 hunks)
  • docs/user-guide/installation/packaged-binary/macos.md (1 hunks)
  • docs/user-guide/installation/packaged-binary/windows.md (1 hunks)
Files skipped from review due to trivial changes (4)
  • docs/README.md
  • docs/user-guide/installation/packaged-binary/gnu-linux.md
  • docs/user-guide/installation/packaged-binary/macos.md
  • docs/user-guide/installation/packaged-binary/windows.md

@TTENSHII TTENSHII merged commit 216e9b2 into dev Oct 30, 2023
12 checks passed
@Saverio976 Saverio976 deleted the fix/RB-156-better-readme branch March 4, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants