blob: 3d469a4baa281ca028e806b72b6cf5245e070288 [file] [log] [blame]
Mark Slee07a3aab2007-03-07 05:45:10 +00001Thrift Tutorial
2
3Author: Mark Slee (mcslee@facebook.com)
4
5Thrift is distributed under the Thrift open source software license.
6Please see the included LICENSE file.
7
8Tutorial
9========
10
111) First things first, you'll need to install the Thrift compiler and the
12 language libraries. Do that using the instructions in the top level
13 README file.
14
152) Read tutorial.thrift to learn about the syntax of a Thrift file
16
David Reissd1c86822009-03-25 22:15:18 +0000173) Compile the code for the language of your choice:
Mark Slee07a3aab2007-03-07 05:45:10 +000018
David Reissd1c86822009-03-25 22:15:18 +000019 $ thrift
David Reiss4438ca52009-03-26 06:14:17 +000020 $ thrift -r --gen cpp tutorial.thrift
Mark Slee07a3aab2007-03-07 05:45:10 +000021
224) Take a look at the generated code.
23
245) Look in the language directories for sample client/server code.
25
266) That's about it for now. This tutorial is intentionally brief. It should be
27 just enough to get you started and ready to build your own project.