kythe.io@v0.0.68-0.20240422202219-7225dbc01741/README.adoc (about)

     1  ////
     2  Copyright 2015 The Kythe Authors. All rights reserved.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8    http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  ////
    16  
    17  = Kythe
    18  19-May-2015
    19  
    20  
    21  image:https://img.shields.io/github/release/kythe/kythe/all.svg[link=https://github.com/kythe/kythe/releases]
    22  image:https://img.shields.io/github/license/kythe/kythe.svg[link=https://github.com/kythe/kythe/blob/master/LICENSE]
    23  
    24  == Features
    25  
    26  * Extensive documentation of the Kythe schema
    27  * Indexer implementations for C++, Go, and Java
    28  * Compilation extractors for javac, Maven, cmake, Go, and link:http://bazel.io/[Bazel]
    29  * Generic verifier for indexers
    30  * Sample cross-reference service
    31  * Many useful utility commands to work with Kythe artifacts
    32  
    33  == Getting Started
    34  
    35  Download the latest Kythe release from https://github.com/kythe/kythe/releases
    36  and then unpack it for a snapshot of Kythe's toolset.
    37  
    38  [source,shell]
    39  ----
    40  tar xzf kythe-v*.tar.gz
    41  rm -rf /opt/kythe
    42  mv kythe-v*/ /opt/kythe
    43  ----
    44  
    45  See `/opt/kythe/README` for a complete description of the packaged tools and their
    46  usages.
    47  
    48  == Contributing and Building Kythe
    49  
    50  https://kythe.io/contributing
    51  
    52  == Issue Tracker
    53  
    54  https://github.com/kythe/kythe/issues
    55  
    56  == Documentation
    57  
    58  https://kythe.io/docs/
    59  
    60  == Examples
    61  
    62  https://kythe.io/examples
    63  
    64  == Contact
    65  
    66   - https://groups.google.com/forum/#!forum/kythe - General Kythe Community
    67   - https://groups.google.com/forum/#!forum/kythe-dev - Kythe Development