Skip to content

Commit 913282e

Browse files
committed
Add more documentation about build tool and language support
1 parent b2a1456 commit 913282e

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

docs/getting-started.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -153,21 +153,40 @@ of Java versions.
153153

154154
## Supported build tools
155155

156+
It's possible to use lsif-java with any Java build tool. Some build tools can be
157+
automatically configured by the `lsif-java index` command while other build
158+
tools may require [manual configuration](manual-configuration.md).
159+
160+
### Automatic configuration
161+
156162
Please open an issue if your build tool is not listed in the table below. Feel
157163
free to subscribe to the tracking issues to receive updates on your build tool.
158164

159-
| Build tool | Single repo navigation | Cross-repo navigation | Tracking issue |
160-
| -------------- | ---------------------- | --------------------- | -------------------------------------------------------------------------------- |
161-
| Maven ||| |
162-
| Gradle v4.0+ ||| |
163-
| Gradle v2.2.1+ ||| [sourcegraph/lsif-java#167](https://github.com/sourcegraph/lsif-java/issues/167) |
164-
| Bazel ||| [sourcegraph/lsif-java#88](https://github.com/sourcegraph/lsif-java/issues/88) |
165-
| Buck ||| [sourcegraph/lsif-java#99](https://github.com/sourcegraph/lsif-java/issues/99) |
166-
| sbt | | | [sourcegraph/lsif-java#110](https://github.com/sourcegraph/lsif-java/issues/110) |
165+
| Build tool | Single repo navigation | Cross-repo navigation | Tracking issue |
166+
| ----------------------- | ---------------------- | --------------------- | -------------------------------------------------------------------------------- |
167+
| Maven ||| |
168+
| Gradle v4.0+ ||| |
169+
| Gradle v2.2.1+ ||| [sourcegraph/lsif-java#167](https://github.com/sourcegraph/lsif-java/issues/167) |
170+
| Bazel ||| [sourcegraph/lsif-java#88](https://github.com/sourcegraph/lsif-java/issues/88) |
171+
| Buck ||| [sourcegraph/lsif-java#99](https://github.com/sourcegraph/lsif-java/issues/99) |
172+
| sbt (v0.13.17, and v1+) | | | |
167173

168174
****: automatic indexing is fully supported. Please report a bug if the
169175
`lsif-java index` command does not work on your codebase.
170176

171177
****: automatic indexing is not supported but (!) you may still be able to use
172178
`lsif-java` by configuring it manually using the instructions
173179
[here](manual-configuration.md).
180+
181+
### Manual configuration
182+
183+
See the [manual configuration](manual-configuration.md) guide for instructions
184+
on how to configure lsif-java to work with any build tool.
185+
186+
## Supported programming languages
187+
188+
| Programming language | Gradle | Maven | sbt | Tracking issue |
189+
| -------------------- | ------ | ----- | --- | --------------------------------------------------------------------------------------------------------------------------- |
190+
| Java |||| |
191+
| Scala |||| [Maven](https://github.com/sourcegraph/lsif-java/issues/301), [Gradle](https://github.com/sourcegraph/lsif-java/issues/302) |
192+
| Kotlin |||| [#302](https://github.com/sourcegraph/lsif-java/issues/302) |

0 commit comments

Comments
 (0)