summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvi Levin <avi.levin@samsung.com>2015-06-09 14:25:11 +0300
committerAvi Levin <avi.levin@samsung.com>2015-06-09 14:25:11 +0300
commit159548e83f01d66b69c291d6ac909cd13fdfdbb7 (patch)
treef948abdfa1b28d9dc09d39170368005a04b1daba
parent9fd8651b61eba779977bba0572aea56fce22424d (diff)
Eolian_info: adding README file
-rw-r--r--README69
1 files changed, 69 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..f5a9da8
--- /dev/null
+++ b/README
@@ -0,0 +1,69 @@
1[Eo_info]
2
3 Introducing Eo_info - the Eoliane eo information getter.
4It enables you easily graphical or text representation of chosen eo classes.
5It uses Eolian to get this information.
6
7[Compiling and installing]
8 [Source Download]
9 https://git.enlightenment.org/devs/avilog/eo_info.git
10
11 [Dependencies]
12 Mandatory:
13 - EFL, Elementary version >= 1.13
14 - CMake
15
16 Non-Mandatory:
17 - Graphviz (Version > 2.35.00) - show application's graph.
18
19 [Building]
20 $ cd eo_info
21 $ mkdir build
22 $ cd build
23 $ cmake ..
24 $ make
25
26 [Installing]
27 (run from "build" directory)
28 $ sudo make install
29
30 [Unstalling]
31 (run from "build" directory)
32 $ sudo make uninstall
33
34[Using Erigo]
35 [Command line options]
36 --help/-h Display this information
37 --noInheritance/-n By default we create the Inheritance tree
38, this flag disable it.
39--inheritors/-i Add the Inheritors tree (classes that inherit from this class)
40--output/-o <outFile> Set output filename to <outFile>
41--depth/-d Set the max depth ( up and down from the class)
42 of the printed tree
43 --include/-I <includeDir> Add <includeDir> to the list of include
44 dirs for scanning. If no directory included we scan the system dir.
45 --filters/-f <filter1,...> Set filters(the info of the class
46 that will be printed) to the list seperated by comma of:
47 events, file
48
49 [examples - from root dir]
50 Get dot reprepensation of inheritance tree of elm_layout.eo till depth 3.
51 Using system libs (used when no libs defined).
52 $ ./build/src/bin/eo_info_cmd -d 3 -o test.dot elm_layout.eo
53
54 Get dot reprepensation of inheritors tree of elm_layout.eo and
55 elm_button.eo till depth 3.
56 $ ./build/src/bin/eo_info_cmd -d 3 -n -i -o test.dot elm_layout.eo Elm.Button
57
58 Get dot reprepensation of inheritance tree of elm_layout.eo till depth 3.
59 Using user defined libs (used when no libs defined).
60 $ ./build/src/bin/eo_info_cmd -d 3 -o test.dot -I /home/avilog/git/efl1/efl/src/lib/ -I /home/avilog/git/efl1/elementary/src/lib/ elm_layout.eo
61
62[other]
63If you have Graphviz installed you can convert the dot file to many other formats:
64SVG
65dot -Tsvg test.dot -o test.svg
66PNG
67dot -Tpng test.dot -o test.png
68
69