-
Notifications
You must be signed in to change notification settings - Fork 109
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
Conversation
WalkthroughThe changes in this pull request focus on the Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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 changesThe 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
- скачать [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` |
There was a problem hiding this comment.
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:
-
Add the step to install mono using homebrew before the ovm installation:
- Install mono using homebrew: `brew install mono`
-
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)
-
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`
-
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?
Столкнулся с проблемами при установке oneScript на macOS. Решил их и дописал в установщик.
Если нужно в другом формате или сначала создать issue, то готов это проделать.
Summary by CodeRabbit
ovm.exe
file.README.md
for better readability.