mirror of https://github.com/tracel-ai/burn.git
Add configuration doc for vscode environment setup (#737)
This commit is contained in:
parent
760c9e1d8e
commit
0dd4ef6b75
|
@ -59,6 +59,25 @@ request. This can be done through the GitHub website or the
|
|||
When submitting your pull request, please provide a brief description of the changes you've made and
|
||||
the issue or issues that your changes address.
|
||||
|
||||
### Optional step for VS Code: Setting up environment
|
||||
|
||||
1. Install the following extensions:
|
||||
|
||||
* [rust-lang.rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
|
||||
* [tamasfe.even-better-toml](https://marketplace.visualstudio.com/items?itemName=tamasfe.even-better-toml)
|
||||
* [serayuzgur.crates](https://marketplace.visualstudio.com/items?itemName=serayuzgur.crates)
|
||||
* [vadimcn.vscode-lldb](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)
|
||||
|
||||
2. Open `Command Palette` with Ctrl+Shift+P or F1 and type `LLDB: Generate Launch Configurations from Cargo.toml` then select it, this will generate a file that should be saved as `.vscode/launch.json`.
|
||||
|
||||
3. Now you can enable breakpoint on code through IDE and then start debugging the library/binary you want, such as the following example:
|
||||
|
||||
<div align="center">
|
||||
<img src="./assets/debug-options-vscode.png" width="700px"/>
|
||||
<div align="left">
|
||||
|
||||
4. If you're creating a new library or binary, keep in mind to repeat the step 2 to always keep a fresh list of targets.
|
||||
|
||||
---
|
||||
|
||||
We look forward to seeing your contributions to the Burn project. Happy coding!
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 189 KiB |
Loading…
Reference in New Issue