summaryrefslogtreecommitdiff
path: root/legacy/eet/doc
diff options
context:
space:
mode:
authorVincent Torri <vincent.torri@gmail.com>2010-03-18 21:51:35 +0000
committerVincent Torri <vincent.torri@gmail.com>2010-03-18 21:51:35 +0000
commit80adafe5fcc657b6d31ac6cedee3202566cc21ba (patch)
treec8c1cc566ea90e9530f07a2715a224b3a0429643 /legacy/eet/doc
parent640cd51bb5de0658ad832de774d689b44c6f9a39 (diff)
add "Compiling" and "Installing" in TOC
SVN revision: 47332
Diffstat (limited to 'legacy/eet/doc')
-rw-r--r--legacy/eet/doc/eet.dox.in46
1 files changed, 46 insertions, 0 deletions
diff --git a/legacy/eet/doc/eet.dox.in b/legacy/eet/doc/eet.dox.in
index 9922fdb3ef..def2370174 100644
--- a/legacy/eet/doc/eet.dox.in
+++ b/legacy/eet/doc/eet.dox.in
@@ -32,6 +32,8 @@ These routines are used for Eet Library interaction
32@li @ref intro 32@li @ref intro
33@li @ref example 33@li @ref example
34@li @ref format 34@li @ref format
35@li @ref compiling
36@li @ref install
35@li @ref next_steps 37@li @ref next_steps
36@li @ref intro_example 38@li @ref intro_example
37 39
@@ -188,6 +190,50 @@ information stored in data structures a simple 1 function call process.
188Please see src/lib/eet_data.c for information on the format of these 190Please see src/lib/eet_data.c for information on the format of these
189specially encoded data entries in an Eet file (for now). 191specially encoded data entries in an Eet file (for now).
190 192
193
194@section compiling How to compile using Eet ?
195
196Eet is a library your application links to. The procedure for this is very
197simple. You simply have to compile your application with the appropriate
198compiler flags that the @p pkg-config script outputs. For example:
199
200Compiling C or C++ files into object files:
201
202@verbatim
203gcc -c -o main.o main.c `pkg-config --cflags eet`
204@endverbatim
205
206Linking object files into a binary executable:
207
208@verbatim
209gcc -o my_application main.o `pkg-config --libs eet`
210@endverbatim
211
212You simply have to make sure that pkg-config is in your shell's PATH (see
213the manual page for your appropriate shell) and eet.pc in /usr/lib/pkgconfig
214or its path is in the PKG_CONFIG_PATH environment variable. It's that simple
215to link and use Eet once you have written your code to use it.
216
217Since the program is linked to Eet, it is now able to use any advertised
218API calls to serialize your data.
219
220You should make sure you add any extra compile and link flags to your
221compile commands that your application may need as well. The above example
222is only guaranteed to make Eet add it's own requirements.
223
224
225@section install How is it installed?
226
227Simple:
228
229@verbatim
230./configure
231make
232su -
233...
234make install
235@endverbatim
236
191@section next_steps Next Steps 237@section next_steps Next Steps
192 238
193to be filled... 239to be filled...