Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the instructions for getting Kythe installed. #135

Merged
merged 1 commit into from
May 12, 2020
Merged

Update the instructions for getting Kythe installed. #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,14 @@ Download Stack from http://docs.haskellstack.org

## Kythe

If you want to use the Kythe frontend, download a [Kythe
release](https://github.com/google/kythe/releases) and unpack it.
If you want to use the Kythe frontend, you'll need to install it either from
source or from the official release. The latter is easier, but the web UI has
been removed in recent versions.

### Official Release

Download a [Kythe release](https://github.com/google/kythe/releases) and unpack
it.

```
tar xzf kythe-v0.0.26.tar.gz -C /opt/
Expand All @@ -44,11 +50,27 @@ ln -s /opt/kythe-v0.0.26 /opt/kythe
chmod -R 755 /opt/kythe/web/ui # It misses permission by default.
```

Version `v0.0.26` is verified to work with Haskell indexer.
Version `v0.0.30` is the latest version that includes the web UI. If you want a
newer Kythe than this, you'll need to build from source.

If you want to install Kythe in a different location to `/opt/kythe` then you
should also set `KYTHE_DIR` to the location of the installation.

### Building From Source

Clone Kythe from [its GitHub repo](https://github.com/google/kythe/releases) and
follow the [Getting Started guide](https://kythe.io/getting-started/) to build
and install it into `/opt/kythe`. Then, from within the Kythe clone, build the
web frontend and copy its files into their rightful place:

```
bazel build //kythe/web/ui
mkdir -p /opt/kythe/web/ui
cp -r bazel-bin/kythe/web/ui/resources/public/* /opt/kythe/web/ui
cp -r kythe/web/ui/resources/public/* /opt/kythe/web/ui
chmod -R 755 /opt/kythe/web/ui
```

## Protoc 3

Download the latest [Proto compiler 3
Expand Down