Add documentation for installation in Eclipse and IntelliJ - #230
Add documentation for installation in Eclipse and IntelliJ#230Entenwilli wants to merge 4 commits into
Conversation
|
@sebinside @uuqjz @Nicolas-Boltz @01Parzival10 @BenjaminArp Some feedback on this would be nice. Should I add some pictures for each/some steps? |
|
I managed to run the analysis by referencing it from a new Project. |
Do you mean IntelliJ, or really Eclipse? |
IntelliJ |
|
I've updated the guide by detailing a few more steps and images. This should hopefully fix it. |
30e1141 to
fb85528
Compare
There was a problem hiding this comment.
I tried to follow the IntelliJ guide but without success. Here are a couple of comments / hints:
- The guide lack an overview that tells less experienced developers (or developers that don't know IntelliJ at all), which steps are required in general
- Many steps lack details are us ambiguous language, e.g., step 2 with "our data flow analysis product" (which product, extracted zip?), "well known location" (which location, does it matter, or just that I know where I put it)
- The pictures help a lot, but are sometimes not enough, e.g., step 5 where you expect the "+" button to be clicked. Also other steps sometimes lack precise information where to look or what to click
- I was not able to understand neither follow step 8 - 11
- The guide ends without showing a final results or showing how to, e.g., execute a test
- Also, you should at least mention for which IntelliJ version you build this guide as things might/will change
TL;DR: In its current version, the guide requires a lot of detail knowledge that it should explain to non-experts in the first place :)
|
I've rephrased the installation instructions. Some tasks are still open:
For which step should I insert more images? |
|
Setup IntelliJ with nightly and current IntelliJ version in 20 minutes without any issues. |
|
Superseeded by #292 |
This PR adds instructions in the README.md to set up the data flow analysis with both eclipse and IntelliJ