Merged in mike-warn-about-ij-bug (pull request #584)

Docs: warn about IntelliJ issue that causes .idea to be wiped at import time
This commit is contained in:
Mike Hearn 2016-11-29 16:08:17 +00:00
commit d87e027bd6
2 changed files with 17 additions and 0 deletions

View File

@ -4,6 +4,17 @@ Getting Set Up : Faultfinding
IntelliJ issues
---------------
Run configurations are missing
******************************
If you opened the Corda project using "Import" from the IntelliJ splash screen rather than using "Open" and then
importing the Gradle build system from the popup bubble, then a bug in IntelliJ will cause it to wipe and recreate
the ``.idea`` directory where the run configurations are stored. The fix is simple and doesn't require you to
re-import the project: just undelete the files! You can do that by either:
1. Running ``git checkout .idea/runConfigurations`` to restore that part of the tree to its normal state.
2. Using the "Version Control" pane in IntelliJ to undelete the files via the GUI.
If IntelliJ complains about lack of an SDK
******************************************

View File

@ -20,6 +20,12 @@ We strongly recommend the use of IntelliJ's Development Environment known as IDE
`JetBrains <https://www.jetbrains.com/idea/download/>`_. The primary reason we recommend this particular IDE is that it integrates
very well with our choice of language for Corda, "Kotlin", as Jetbrains also support the development of Kotlin.
.. warning:: When opening the Corda project for the first time from the IntelliJ splash screen, please use "Open"
and then agree to import the Gradle project from the popup bubble. Don't pick "Import" on the splash screen,
because a bug in IntelliJ will cause the pre-packaged run configurations to be erased. If you see this warning
too late, it's no problem, just use ``git checkout .idea/runConfiguration`` or the version control tab in IntelliJ
to undelete the files.
Kotlin
------