Add "How to Build" Documentation
wje600 opened this issue · 6 comments
It would make it easier to use/contribute to the project if there were some documentation on how to get it to build.
Somebody already made a good start with this, but unfortunately it's in Russian: shurik111333@5e17203#diff-3a9efde467c227a3e569aed0ccb180d9
Here's the Google translated version:
How to build the plugin:
0) Open the project
- Add the IDEA Plugin SDK
File -> Project structure
In the left pane, under Project Settings, click Project
In the right pane, under Project SDK, click New -> Intellij Platform Plugin SDK
In the window that appears, specify the folder with Intellij IDEA installed - Add plug-in libraries to the SDK
File -> Project structure
In the left pane under Platform Settings, select SDKs
From the list on the right select the one created in the first step of the SDK
Add jar files to the "Classpath" list from the following folders:
- Idea_directory * \ plugins \ Kotlin \ lib
- Idea_directory * \ plugins \ Kotlin \ kotlinc
- Idea_directory * \ plugins \ Groovy \ lib
- Launch Project Build
Perhaps there are some missing details (versions, etc.) that, if supplied, would make these instructions work. As shown above, I am unable to succeed.
Which error do you get exactly?
After considerable exploration, I believe I have discovered the essence of the difficulty: The project in general appears to be oriented around the Ultimate Edition of IntelliJ, which contains built-in support for various file types - such as JavaScript, CSS, etc. Attempting to build using the Community Edition of IntelliJ leads to quite a number of missing libraries and dependencies. (As an aside, I discovered that I was able to resolve these dependencies by downloading WebStorm, the web-oriented IDE from JetBrains, and adding various libraries.)
That is valuable information. Thank you for the feed back, I will incorporate this in the documentation.
instructions are added to the README.md