-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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 'IDEs Support' section in README #3309
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -678,15 +678,46 @@ Now we can proceed as with Spike, debugging works in a similar way: | |||||
|
||||||
Further information about GDB debugging is available [here](https://sourceware.org/gdb/onlinedocs/gdb/) and [here](https://sourceware.org/gdb/onlinedocs/gdb/Remote-Debugging.html#Remote-Debugging). | ||||||
|
||||||
## <a name="ide"></a> Building Rocket Chip with an IDE | ||||||
## <a name="ide"></a> IDEs Support | ||||||
|
||||||
The Rocket Chip Scala build uses [mill](https://github.com/com-lihaoyi/mill) as build tool. | ||||||
IDEs like [IntelliJ](https://www.jetbrains.com/idea/) and [VSCode](https://code.visualstudio.com/) | ||||||
are popular in the Scala community and work with Rocket Chip. Use: | ||||||
``` | ||||||
mill mill.bsp.BSP/install | ||||||
``` | ||||||
to use one of these IDEs, there is one minor peculiarity of the Rocket Chip build that must be addressed. | ||||||
|
||||||
IDEs like [IntelliJ](https://www.jetbrains.com/idea/) and [VSCode](https://code.visualstudio.com/) are popular in the Scala community and work with Rocket Chip. | ||||||
|
||||||
The Rocket Chip currently uses `nix` to configure the build and/or development environment, you need to install it first depending on your OS distro. | ||||||
|
||||||
Then follow the steps: | ||||||
|
||||||
1. Generate BSP config by running: | ||||||
|
||||||
``` | ||||||
mill mill.bsp.BSP/install | ||||||
``` | ||||||
|
||||||
2. Patch the `argv` in `.bsp/mill-bsp.json`, from | ||||||
|
||||||
```json | ||||||
{"name":"mill-bsp","argv":["/usr/bin/mill","--bsp","--disable-ticker","--color","false","--jobs","1"],"millVersion":"0.10.9","bspVersion":"2.0.0","languages":["scala","java"]} | ||||||
``` | ||||||
|
||||||
to | ||||||
|
||||||
```json | ||||||
{"name":"mill-bsp","argv":["/usr/bin/nix","develop","-c","mill","--bsp","--disable-ticker","--color","false","--jobs","1"],"millVersion":"0.10.9","bspVersion":"2.0.0","languages":["scala","java"]} | ||||||
``` | ||||||
|
||||||
### For IntelliJ users | ||||||
|
||||||
3. Install and configure [Scala](https://plugins.jetbrains.com/plugin/1347-scala) plugin. | ||||||
|
||||||
4. BSP should be automatically run. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
If it doesn't, click `bsp` on the right bar, then right-click on your project to reload. | ||||||
|
||||||
### For VSCode users | ||||||
|
||||||
3. Install and configure [Metals](https://marketplace.visualstudio.com/items?itemName=scalameta.metals) extension. | ||||||
|
||||||
4. Execute VSCode command `Metals: Import build`. | ||||||
|
||||||
## <a name="contributors"></a> Contributors | ||||||
|
||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.