| //// |
| Copyright 2015 Google Inc. All rights reserved. |
| |
| Licensed under the Apache License, Version 2.0 (the "License"); |
| you may not use this file except in compliance with the License. |
| You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| //// |
| |
| = Kythe |
| 19-May-2015 |
| :toc2: |
| |
| == Features |
| |
| * Extensive documentation of the Kythe schema |
| * Indexer implementations for C++ and Java |
| * Compilation extractors for javac, Maven, cmake, Go, and link:http://bazel.io/[Bazel] |
| * Generic verifier for indexers |
| * Sample cross-reference service and accompanying web UI |
| * Many useful utility commands to work with Kythe artifacts |
| |
| == Getting Started |
| |
| Download the latest Kythe release from https://github.com/google/kythe/releases |
| and then unpack it for a snapshot of Kythe's toolset. |
| |
| [source,shell] |
| ---- |
| tar xzf kythe-v*.tar.gz |
| rm -rf /opt/kythe |
| mv kythe-v*/ /opt/kythe |
| ---- |
| |
| See /opt/kythe/README for a complete description of the packaged tools and their |
| usages. |
| |
| == Contributing and Building Kythe |
| |
| http://kythe.io/contributing |
| |
| == Issue Tracker |
| |
| http://kythe.io/phabricator/maniphest |
| |
| == Documentation |
| |
| http://kythe.io/docs/ |
| |
| == Examples |
| |
| http://kythe.io/examples |
| |
| == Contact |
| |
| - https://groups.google.com/forum/#!forum/kythe - General Kythe Community |
| - https://groups.google.com/forum/#!forum/kythe-dev - Kythe Development |
