Skip to content
This repository has been archived by the owner on Mar 2, 2021. It is now read-only.

Added a guide to import the repo into IntelliJ #98

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,30 @@ executable on your `PATH`.

The default bootrom consists of a bootloader that loads a program off the SD
card slot on the VC707 board.

IntelliJ Setup
-------------------------------
This subsection will help you to setup IntelliJ.
The steps will describe what options you have to choose to get a hassle-free build.
If not otherwise stated, simply press next or hit enter in the corresponding dialog to get to the next step.

1. Select "Import project"
![Welcome screen](documentation/intellij-setup-01-welcome-screen.png)

2. Locate the root folder of the freedom repository
![Folder window](documentation/intellij-setup-02-find-freedom-folder.png)

3. Select sbt as a external model to import the project from
![Model import selection](documentation/intellij-setup-03-select-sbt-import.png)

4. Check the option to use the sbt shell for build and import
![Project sbt setting](documentation/intellij-setup-04-import-project-source-and-sbt-settings.png)

5. The IDE will open and try to import the freedom package. This will fail because IntelliJ builds all submodules with the version of the individual build.sbt file. We need to change that. Continue with the next step
![IDE window](documentation/intellij-setup-05-first-ide-start.png)

6. Switch to the sbt shell and enter ++2.12.4
![IDE sbt shell window](documentation/intellij-setup-06-sbt-shell-version-setting.png)

Done. IntelliJ now should be able to build the repository and show you code highlighting.
You might need to hit reimport in the build view which can be seen in step 5.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.