summaryrefslogtreecommitdiff
path: root/src/lib/embryo
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 23:26:05 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2012-12-28 23:26:05 +0000
commit2608f68571b277967b2e27d6136c95f03befd183 (patch)
tree24a3b2764432b9fbde980aabf6bc40e7c74b1610 /src/lib/embryo
parent4f6a4e59a4e7774fe55ae3ecf37d42faabec07e4 (diff)
efl/docs: clean-up and make it more uniform.
now unified docs are bit more uniform in their start pages, overall improved but much to do :-( SVN revision: 81851
Diffstat (limited to 'src/lib/embryo')
-rw-r--r--src/lib/embryo/Embryo.h56
1 files changed, 41 insertions, 15 deletions
diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h
index 1f14e12383..e9020d4ced 100644
--- a/src/lib/embryo/Embryo.h
+++ b/src/lib/embryo/Embryo.h
@@ -3,16 +3,18 @@
3 3
4These routines are used for Embryo. 4These routines are used for Embryo.
5 5
6@page embryo_main Embryo Library Documentation 6@page embryo_main Embryo
7 7
8@image html e_big.png 8@date 2004 (created)
9@note based on Compuphase (http://www.compuphase.com) PAWN language.
9 10
10@version 1.7.0 11@section toc Table of Contents
11@author Carsten Haitzler <raster\@rasterman.com>
12@author Compuphase http://www.compuphase.com
13@date 2004-2012
14 12
15@section intro What is Embryo? 13@li @ref embryo_main_intro
14@li @ref embryo_main_compiling
15@li @ref embryo_main_next_steps
16
17@section embryo_main_intro Introduction
16 18
17Embryo is a tiny library designed to interpret limited Small programs 19Embryo is a tiny library designed to interpret limited Small programs
18compiled by the included compiler, @c embryo_cc. It is mostly a cleaned 20compiled by the included compiler, @c embryo_cc. It is mostly a cleaned
@@ -26,16 +28,40 @@ For more information about the Pawn language, see
26@latexonly http://www.compuphase.com/pawn/pawn.htm @endlatexonly 28@latexonly http://www.compuphase.com/pawn/pawn.htm @endlatexonly
27For the basics about the Small language, see @ref Small_Page. 29For the basics about the Small language, see @ref Small_Page.
28 30
29@section How_to_Use How to Use Embryo? 31@section embryo_main_compiling How to compile
32
33Embryo is a library your application links to. The procedure for this
34is very simple. You simply have to compile your application with the
35appropriate compiler flags that the @p pkg-config script outputs. For
36example:
37
38Compiling C or C++ files into object files:
39
40@verbatim
41gcc -c -o main.o main.c `pkg-config --cflags embryo`
42@endverbatim
43
44Linking object files into a binary executable:
45
46@verbatim
47gcc -o my_application main.o `pkg-config --libs embryo`
48@endverbatim
49
50See @ref pkgconfig
51
52@section embryo_main_next_steps Next Steps
53
54After you understood what Embryo is and installed it in your system you
55should proceed understanding the programming interface.
56
57Recommended reading:
58
59@li @ref Embryo_Program_Creation_Group to create Embryo from memory or file.
60@li @ref Embryo_Func_Group to expose functions to Embryo.
61@li @ref Embryo_Program_VM_Group to push pop virtual machine.
62@li @ref Embryo_Run_Group to run it.
30 63
31To use Embryo in your code, you need to do at least the following:
32 64
33@li Include @ref Embryo.h.
34@li Load the Embryo program using one of the
35 @ref Embryo_Program_Creation_Group.
36@li Set up the native calls with @ref embryo_program_native_call_add.
37@li Create a virtual machine with @ref embryo_program_vm_push.
38@li Then run the program with @ref embryo_program_run.
39 65
40@todo Clean up compiler code. 66@todo Clean up compiler code.
41@todo Proper overview of the operation of the interpreter, that is how 67@todo Proper overview of the operation of the interpreter, that is how