-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Update README.md #10612
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
base: main
Are you sure you want to change the base?
Update README.md #10612
Conversation
WalkthroughDocumentation update to README.md adding Windows-specific guidance to the Run instruction. The change appends a note instructing Windows users to open the terminal with Administrator privileges before executing the run command. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (6 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example:
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. Comment |
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: 0
🧹 Nitpick comments (1)
README.md (1)
54-57: Improve phrasing and formatting of the Windows admin privileges note.The inline note is helpful but has clarity issues: (1) the phrasing "and run." is incomplete and awkward, (2) placing the note inline with the instruction breaks readability, and (3) the format is inconsistent with structured notes elsewhere in the document (e.g., lines 80–86 use
> [!NOTE]blocks).Consider restructuring this section for better clarity:
- To start Langflow, run: (For Windows: open terminal with Admin Privileges and run.) + To start Langflow, run: + + > [!NOTE] + > On Windows, open the terminal with administrator privileges before running this command. + ```shell uv run langflow runAlternatively, if you prefer inline text, revise it to: ```diff - To start Langflow, run: (For Windows: open terminal with Admin Privileges and run.) + To start Langflow, run the command below. (Windows users: open the terminal with administrator privileges first.)
There was no mention of running the
langflow runcommand in an Admin Privileged Terminal.Thus, the edit.
Thank you.
Summary by CodeRabbit