thrift/tutorial
Jake Farrell 9623fc5476 updating java tutorial readme
git-svn-id: https://svn.apache.org/repos/asf/thrift/trunk@1150692 13f79535-47bb-0310-9956-ffa450edef68
2011-07-25 13:22:14 +00:00
..
cpp THRIFT-920. cpp: C++ Test and Tutorial does not compile anymore due to the change within Enum handling 2010-09-27 17:26:02 +00:00
csharp THRIFT-881. csharp: add csharp to the tutorial 2010-09-24 16:47:59 +00:00
erl add a little README 2011-02-16 06:00:10 +00:00
go THRIFT-625: Add support for 'Go'; provided by Aalok Shah. 2011-02-20 02:39:19 +00:00
hs add ASL to a handful of files 2010-07-28 18:23:22 +00:00
java updating java tutorial readme 2011-07-25 13:22:14 +00:00
js THRIFT-1133 Java and JavaScript tutorial is broken since we have Java maven deployment 2011-04-08 21:28:50 +00:00
perl THRIFT-619: Perl server and example 2009-11-12 03:01:33 +00:00
php THRIFT-592. php: Make the tutorial work properly after r815878 2009-12-09 19:29:48 +00:00
py THRIFT-387. Add license headers to a bunch of files 2009-03-30 21:35:00 +00:00
py.twisted THRIFT-1024 Add Python Twisted example to the Tutorial 2011-01-03 20:19:07 +00:00
rb THRIFT-486. rb: ruby tutorial needs updated require statements 2009-05-05 18:59:49 +00:00
README THRIFT-387. Add appropriate Apache header to all code files 2009-04-08 00:19:37 +00:00
shared.thrift THRIFT-387. Add license headers to a bunch of files 2009-03-30 21:35:00 +00:00
tutorial.thrift THRIFT-890. java: Fix tutorial to build and run in trunk 2010-09-27 18:26:07 +00:00

Thrift Tutorial

License
=======

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.

Tutorial
========

1) First things first, you'll need to install the Thrift compiler and the
   language libraries. Do that using the instructions in the top level
   README file.

2) Read tutorial.thrift to learn about the syntax of a Thrift file

3) Compile the code for the language of your choice:

     $ thrift
     $ thrift -r --gen cpp tutorial.thrift

4) Take a look at the generated code.

5) Look in the language directories for sample client/server code.

6) That's about it for now. This tutorial is intentionally brief. It should be
   just enough to get you started and ready to build your own project.