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

Расширил описание для macos #1460

Merged
merged 3 commits into from
Oct 18, 2024

Conversation

Oxotka
Copy link
Contributor

@Oxotka Oxotka commented Oct 17, 2024

Столкнулся с проблемами при установке oneScript на macOS. Решил их и дописал в установщик.
Если нужно в другом формате или сначала создать issue, то готов это проделать.

Summary by CodeRabbit

  • Documentation
    • Enhanced installation instructions for MacOS, clarifying steps for downloading and executing the ovm.exe file.
    • Added a tip for specifying the path by dragging the file into the terminal.
    • Improved clarity and specificity in the manual local build instructions.
    • Minor formatting adjustments throughout the README.md for better readability.

Copy link

coderabbitai bot commented Oct 17, 2024

Walkthrough

The changes in this pull request focus on the README.md file for the OneScript project. The modifications primarily enhance the installation instructions for MacOS, providing clearer steps for downloading and executing the ovm.exe file. The updates include specific details on the file to download and improved command guidance for installation. Minor formatting adjustments and clarifications throughout the document also contribute to a more user-friendly experience, while the overall structure of the document remains unchanged.

Changes

File Change Summary
README.md Updated MacOS installation instructions for clarity; specified download file and execution commands; minor formatting adjustments throughout.

Poem

In the land of code where rabbits play,
The README shines bright, guiding the way.
With clearer paths and steps to take,
A joyful hop for every mistake! 🐇✨
So grab your tools, let’s build and run,
With every change, we’re having fun!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2c8de5c and fb86bfd.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5597092 and 2c8de5c.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
README.md (1)

Line range hint 1-47: Overall assessment of the changes

The modifications to the README.md file successfully address the PR objectives by enhancing the installation instructions for OneScript on macOS. The added details provide clearer steps for downloading and executing the ovm.exe file, which should help users avoid installation issues.

The changes are a significant improvement over the previous version. With the suggested enhancements from the previous comment, the instructions will be even more comprehensive and user-friendly.

Thank you for your contribution to improving the documentation!

🧰 Tools
🪛 Markdownlint

50-50: Expected: atx_closed; Actual: atx
Heading style

(MD003, heading-style)

README.md Outdated
Comment on lines 45 to 47
- скачать [ovm](https://github.com/oscript-library/ovm/releases). Скачиваем именно `ovm.exe`
- выполнить команду `mono path/to/ovm.exe install stable`. Чтобы корректно указать путь до `ovm.exe` можно перенести мышкой файл `ovm.exe`. Должно получится примерно так: `mono Users/username/Downloads/ovm.exe install stable`
- выполнить команду `mono path/to/ovm.exe use stable`
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Enhance MacOS installation instructions

Thank you for improving the MacOS installation instructions. The added details will certainly help users install OneScript more easily. However, I have a few suggestions to make the instructions even more comprehensive and consistent:

  1. Add the step to install mono using homebrew before the ovm installation:

    - Install mono using homebrew: `brew install mono`
  2. Consider using a more MacOS-friendly naming convention for the executable:

    - Download [ovm](https://github.com/oscript-library/ovm/releases). Download the file named `ovm.exe` (despite the .exe extension, this file works on MacOS)
  3. Add a step to include the installation directory in the PATH:

    - Add the OneScript installation directory to your PATH. You can do this by adding the following line to your `~/.bash_profile` or `~/.zshrc` file:

    export PATH=$PATH:/usr/local/bin/oscript

    - Reload your shell configuration: `source ~/.bash_profile` or `source ~/.zshrc`
    
  4. Consider using backticks for inline code formatting consistently:

    - Execute the command `mono /path/to/ovm.exe install stable`. To correctly specify the path to `ovm.exe`, you can drag and drop the `ovm.exe` file into the terminal. The command should look similar to: `mono /Users/username/Downloads/ovm.exe install stable`
    - Execute the command `mono /path/to/ovm.exe use stable`

These changes will provide a more complete and consistent set of instructions for MacOS users.

Would you like me to provide a complete revised version of the MacOS installation section incorporating these suggestions?

@EvilBeaver EvilBeaver merged commit 85f0770 into EvilBeaver:develop Oct 18, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants