#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you 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.
#

Templeton
=========

Templeton is a webapi on top of HCatalog and other Hadoop services.

Install
=======

Templeton is deep in the middle of development and doesn't have a
smooth install procedure.  As such, it should only be installed by expert
developers.

To install Templeton, read the installation section in the Templeton
manual.

Documentation
=============

templeton_docs.pdf is a pre-built, pdf version of the Templeton manual.

To build the Templeton documentation fresh from the source, run
forrest in the src/docs directory.  This will create
src/docs/build/site which will contain a complete html version of the
Templeton documentation site. (Open index.html in your browser.)  In
addition, src/docs/build/site/wholesite.pdf will be a fresh pdf
version of the complete site in one file.