README.md
1Thrift Tutorial
2
3License
4=======
5
6Licensed to the Apache Software Foundation (ASF) under one
7or more contributor license agreements. See the NOTICE file
8distributed with this work for additional information
9regarding copyright ownership. The ASF licenses this file
10to you under the Apache License, Version 2.0 (the
11"License"); you may not use this file except in compliance
12with the License. You may obtain a copy of the License at
13
14 http://www.apache.org/licenses/LICENSE-2.0
15
16Unless required by applicable law or agreed to in writing,
17software distributed under the License is distributed on an
18"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19KIND, either express or implied. See the License for the
20specific language governing permissions and limitations
21under the License.
22
23Tutorial
24========
25
261) First things first, you'll need to install the Thrift compiler and the
27 language libraries. Do that using the instructions in the top level
28 README.md file.
29
302) Read tutorial.thrift to learn about the syntax of a Thrift file
31
323) Compile the code for the language of your choice:
33```
34 $ thrift
35 $ thrift -r --gen cpp tutorial.thrift
36```
374) Take a look at the generated code.
38
395) Look in the language directories for sample client/server code.
40
416) That's about it for now. This tutorial is intentionally brief. It should be
42 just enough to get you started and ready to build your own project.
43