ide-java icon indicating copy to clipboard operation
ide-java copied to clipboard

Add a FAQ section in Readme or Wiki

Open thefzsalam opened this issue 7 years ago • 5 comments

List commonly encountered problems in a FAQ section in Readme or the Wiki. I would like to suggest the following:

  • When importing a barebones gradle project, (for example:https://github.com/czak/minimal-android-project), if you encounter a classpath not found error, there might be some error in build.gradle. Try opening a command line and type: gradle build to see if there's any error. (for example, could not download the plugin)
  • atom-ide-ui package is required for this package to work.
  • If you encounter an error like this: The declared package does not match the expected package as described in this SO question, create a file named .classpath next to build.gradle and add the following:
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
    <classpathentry kind="src" path="src/main/java"/>
</classpath>
  • Note: Change path="src/main/java" to where your packages reside. (The SO question explains the issue clearly. It would be appreciated if someone could express the issue in concise words here to explain our problem clearly.)
  • To enable completion for android sdk, add the following to the above mentioned .classpath file between <classpath> ... </classpath>: <classpathentry kind="lib" path="/path/to/android-sdk/platforms/android-XX/android.jar"/>
  • Where XX stands for compileSdkVersion specified in build.gradle.

thefzsalam avatar Mar 24 '18 06:03 thefzsalam

atom-ide-ui package is required for this package to work

Is already in the README.

Would accept a PR to add an FAQ around the project system though - that would be super helpful! :)

damieng avatar Mar 24 '18 18:03 damieng

Should be noted according to the Eclipse language server readme that Gradle support is minimal and Android projects are not supported.

CaptainBeyondDS8 avatar Mar 26 '18 17:03 CaptainBeyondDS8

I think rather than try and keep up with the language servers README we should probably just link directly to it from our README when it comes to 'compatibility and features'?

damieng avatar Mar 26 '18 17:03 damieng

I just added an issue there: https://github.com/eclipse/eclipse.jdt.ls/issues/606

thefzsalam avatar Mar 30 '18 17:03 thefzsalam

This would be really helpful.

YtvwlD avatar Feb 09 '19 14:02 YtvwlD