-
-
Notifications
You must be signed in to change notification settings - Fork 76
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
Update README.md #474
Update README.md #474
Conversation
added more instructions
Review ChecklistDoes this PR follow the Contribution Guidelines? Following is a partial checklist: Proper conventional commit scoping:
If applicable:
|
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.
Thanks for the contribution 🙏
I've left some comments about why I don't see these changes as necessary.
@@ -184,6 +184,11 @@ vim.keymap.set( | |||
:RustLsp[!] debuggables {args[]}? | |||
:RustLsp[!] debug {args[]}? | |||
``` | |||
Example: | |||
1. Press escape |
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.
This sounds like you're instructing to leave insert mode? What if you're already in normal mode?
Example: | ||
1. Press escape | ||
2. `:RustLsp debuggables` | ||
3. You will be prompted with choice, for example select 1. |
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.
This is redundant and would have to be added for any command that can prompt (there are many) for consistency.
@@ -202,6 +207,15 @@ vim.keymap.set( | |||
- A debug adapter (e.g. [`lldb`](https://lldb.llvm.org/) | |||
or [`codelldb`](https://github.com/vadimcn/codelldb) | |||
|
|||
**NB!!!** make sure after install lldb ([`nvim-dap`](https://github.com/mfussenegger/nvim-dap) recommends [lldb-dap](https://lldb.llvm.org/resources/lldbdap.html)) |
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.
This isn't always necessary and this information belongs in the install instructions for lldb-dap.
The fact that external dependencies have to be on the PATH applies to any external dependency. Usually, your package manager takes care of that and if it doesn't, that's an issue with your package manager.
If it isn't on the PATH, we report it in the health check.
I've updated the lldb-dap URL in the readme: 678ff9d |
Updated Readme for debug section to be more specific about some issues that I faced. Mb it will help other people as well.