Skip to content

Commit

Permalink
Updated README to reflect latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
vknabel committed Aug 9, 2019
1 parent 4fa0653 commit 5f3df9f
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,27 @@ pronounced: [source kite] :smile:

[SDE](https://github.com/jinmingjian/sde)'s language server's backend which is written in Swift. You need to build this tool if you want to use [SDE](https://github.com/jinmingjian/sde).

| Swift version | sourcekite version |
| ------------- | ----------------------------------------------------------------- |
| 5 | [0.6.0](https://github.com/vknabel/sourcekite/releases/tag/0.6.0) |
| 4 and 5 | [0.5.0](https://github.com/vknabel/sourcekite/releases/tag/0.5.0) |
| 3.1 and 4 | [0.4.2](https://github.com/vknabel/sourcekite/releases/tag/0.4.2) |

## Build Instructions

clone this project, then run build command in that project as follow:

### for Linux

> sudo ln -s /usr/lib/sourcekitdInProc.framework/sourcekitdInProc /usr/lib/sourcekitdInProc
> make install
> make install PREFIX=/usr/local
change the above linking location/option to your own when necessary)

For more information see [jpsim/SourceKitten#how-is-sourcekit-resolved](https://github.com/jpsim/SourceKitten#how-is-sourcekit-resolved).

### for MacOS

> make install
(NOTE: make sure you have installed the swift toolchain into that location. You can do this via [download from offical site](https://swift.org/download/#snapshots) or [swiftenv](https://swiftenv.fuller.li))
Expand All @@ -24,13 +33,14 @@ Finally set "swift.path.sourcekite" in vscode to let SDE know the location of th

```javascript
{
"swift.path.sourcekite": "/path/to/repo/sourcekite/.build/release/sourcekite"
"swift.path.sourcekite": "/usr/local/bin/sourcekite"
}
```


## Issues

file an issues if you have problem.

## License

Apache License v2.

0 comments on commit 5f3df9f

Please sign in to comment.